forked from kedacore/keda-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Release: Prepare v2.14 (kedacore#1382)
* pending prs Signed-off-by: Jorge Turrado <[email protected]> * prepare v2.14 Signed-off-by: Jorge Turrado <[email protected]> * remove url ignores Signed-off-by: Jorge Turrado <[email protected]> * include the latest change Signed-off-by: Jorge Turrado <[email protected]> * add missing changes Signed-off-by: Jorge Turrado <[email protected]> --------- Signed-off-by: Jorge Turrado <[email protected]>
- Loading branch information
Showing
113 changed files
with
14,615 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
content/docs/2.14/authentication-providers/gcp-secret-manager.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| +++ | ||
| title = "GCP Secret Manager" | ||
| +++ | ||
|
|
||
| You can pull secrets from GCP Secret Manager into the trigger by using the `gcpSecretManager` key. | ||
|
|
||
| The `secrets` list defines the mapping between the secret and the authentication parameter. | ||
|
|
||
| GCP IAM Service Account credentials can be used for authenticating with the Secret Manager service, which can be provided using a Kubernetes secret. Alternatively, `gcp` pod identity provider is also supported for GCP Secret Manager using `podIdentity` inside `gcpSecretManager`. | ||
|
|
||
| ```yaml | ||
| gcpSecretManager: # Optional. | ||
| secrets: # Required. | ||
| - parameter: {param-name-used-for-auth} # Required. | ||
| id: {secret-manager-secret-name} # Required. | ||
| version: {secret-manager-secret-name} # Optional. | ||
| podIdentity: # Optional. | ||
| provider: gcp # Required. | ||
| credentials: # Optional. | ||
| clientSecret: # Required. | ||
| valueFrom: # Required. | ||
| secretKeyRef: # Required. | ||
| name: {k8s-secret-with-gcp-iam-sa-secret} # Required. | ||
| key: {key-within-the-secret} # Required. | ||
| ``` | ||
| ### Steps to create the IAM Service Account Kubernetes secret | ||
| - Create a new GCP IAM service account. In case you would like to use an existing service account, you can skip this step. | ||
| ```shell | ||
| gcloud iam service-accounts create GSA_NAME \ | ||
| --project=GSA_PROJECT | ||
| ``` | ||
|
|
||
| Replace the following: | ||
|
|
||
| GSA_NAME: the name of the new IAM service account.\ | ||
| GSA_PROJECT: the project ID of the Google Cloud project for your IAM service account. | ||
|
|
||
| - Ensure that your IAM service account has [roles](https://cloud.google.com/iam/docs/understanding-roles) which provide sufficient [permissions](https://cloud.google.com/iam/docs/permissions-reference) needed to retrieve the secrets, such as the [Secret Manager Secret Accessor](https://cloud.google.com/secret-manager/docs/access-control#secretmanager.secretAccessor). You can grant additional roles using the following command: | ||
|
|
||
| ```shell | ||
| gcloud projects add-iam-policy-binding PROJECT_ID \ | ||
| --member "serviceAccount:GSA_NAME@GSA_PROJECT.iam.gserviceaccount.com" \ | ||
| --role "ROLE_NAME" | ||
| ``` | ||
|
|
||
| Replace the following: | ||
|
|
||
| PROJECT_ID: your Google Cloud project ID. \ | ||
| GSA_NAME: the name of your IAM service account. \ | ||
| GSA_PROJECT: the project ID of the Google Cloud project of your IAM service account. \ | ||
| ROLE_NAME: the IAM role to assign to your service account, like roles/secretmanager.secretaccessor. | ||
|
|
||
| - Either setup [GCP workload identity](./gcp-workload-identity) or create a JSON key credential for authenticating with the service account: | ||
|
|
||
| ```shell | ||
| gcloud iam service-accounts keys create KEY_FILE \ | ||
| --iam-account=GSA_NAME@PROJECT_ID.iam.gserviceaccount.com | ||
| ``` | ||
|
|
||
| Replace the following: | ||
|
|
||
| KEY_FILE: the file path to a new output file for the private key in your local machine. \ | ||
| GSA_NAME: the name of your IAM service account. \ | ||
| PROJECT_ID: your Google Cloud project ID. | ||
|
|
||
| - Create a Kubernetes secret for storing the SA key file in the same namespace where you will create the `TriggerAuthentication` resource: | ||
|
|
||
| ```shell | ||
| kubectl create secret generic NAME --from-file=KEY=KEY_FILE -n NAMESPACE | ||
| ``` | ||
|
|
||
| Replace the following: | ||
|
|
||
| NAME: name of the Kubernetes secret resource. \ | ||
| KEY: Kubernetes secret key for the SA. \ | ||
| KEY_FILE: the file path to the SA in your local machine. \ | ||
| NAMESPACE: the namespace in which the `TriggerAuthentication` resource will be created. | ||
|
|
||
| Now you can create the `TriggerAuthentication` resource which references the secret-name and key for the SA. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| +++ | ||
| title = "The KEDA Documentation" | ||
| weight = 1 | ||
| +++ | ||
|
|
||
| Welcome to the documentation for **KEDA**, the Kubernetes Event-driven Autoscaler. Use the navigation to the left to learn more about how to use KEDA and its components. | ||
|
|
||
| Additions and contributions to these docs are managed on [the keda-docs GitHub repo](https://github.com/kedacore/keda-docs). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| +++ | ||
| title = "Authentication Providers" | ||
| weight = 5 | ||
| +++ | ||
|
|
||
| Available authentication providers for KEDA: | ||
|
|
||
| {{< authentication-providers >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| +++ | ||
| title = "AWS EKS Pod Identity Webhook" | ||
| +++ | ||
|
|
||
| [**EKS Pod Identity Webhook**](https://github.com/aws/amazon-eks-pod-identity-webhook), which is described more in depth [here](https://aws.amazon.com/blogs/opensource/introducing-fine-grained-iam-roles-service-accounts/), allows you to provide the role name using an annotation on a service account associated with your pod. | ||
|
|
||
| > ⚠️ **WARNING:** [`aws-eks` auth has been deprecated](https://github.com/kedacore/keda/discussions/5343) and support for it will be removed from KEDA on v3. We strongly encourage the migration to [`aws` auth](./aws.md). | ||
| You can tell KEDA to use EKS Pod Identity Webhook via `podIdentity.provider`. | ||
|
|
||
| ```yaml | ||
| podIdentity: | ||
| provider: aws-eks # Optional. Default: none | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| +++ | ||
| title = "AWS Kiam Pod Identity" | ||
| +++ | ||
|
|
||
| [**Kiam**](https://github.com/uswitch/kiam/) lets you bind an AWS IAM Role to a pod using an annotation on the pod. | ||
|
|
||
| > ⚠️ **WARNING:** `aws-kiam` auth has been deprecated given [AWS KIAM is no longer maintained](https://github.com/uswitch/kiam/#-%EF%B8%8Fthis-project-is-now-being-abandoned-%EF%B8%8F-). As a result, [support for it will be removed from KEDA on v2.15](https://github.com/kedacore/keda/discussions/5342). We strongly encourage the migration to [`aws` auth](./aws.md). | ||
| You can tell KEDA to use Kiam via `podIdentity.provider`. | ||
|
|
||
| ```yaml | ||
| podIdentity: | ||
| provider: aws-kiam # Optional. Default: none | ||
| ``` |
40 changes: 40 additions & 0 deletions
40
content/docs/2.15/authentication-providers/aws-secret-manager.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| +++ | ||
| title = "AWS Secret Manager" | ||
| +++ | ||
|
|
||
| You can integrate AWS Secret Manager secrets into your trigger by configuring the `awsSecretManager` key in your KEDA scaling specification. | ||
|
|
||
| The `podIdentity` section configures the usage of AWS pod identity with the provider set to AWS. | ||
|
|
||
| The `credentials` section specifies AWS credentials, including the `accessKey` and `secretAccessKey`. | ||
|
|
||
| - **accessKey:** Configuration for the AWS access key. | ||
| - **secretAccessKey:** Configuration for the AWS secret access key. | ||
|
|
||
| The `region` parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified. | ||
|
|
||
| The `secrets` list within `awsSecretManager` defines the mapping between the AWS Secret Manager secret and the authentication parameter used in your application, including the parameter name, AWS Secret Manager secret name, and an optional version parameter, defaulting to the latest version if unspecified. | ||
|
|
||
| ### Configuration | ||
|
|
||
| ```yaml | ||
| awsSecretManager: | ||
| podIdentity: # Optional. | ||
| provider: aws # Required. | ||
| credentials: # Optional. | ||
| accessKey: # Required. | ||
| valueFrom: # Required. | ||
| secretKeyRef: # Required. | ||
| name: {k8s-secret-with-aws-credentials} # Required. | ||
| key: {key-in-k8s-secret} # Required. | ||
| accessSecretKey: # Required. | ||
| valueFrom: # Required. | ||
| secretKeyRef: # Required. | ||
| name: {k8s-secret-with-aws-credentials} # Required. | ||
| key: {key-in-k8s-secret} # Required. | ||
| region: {aws-region} # Optional. | ||
| secrets: # Required. | ||
| - parameter: {param-name-used-for-auth} # Required. | ||
| name: {aws-secret-name} # Required. | ||
| version: {aws-secret-version} # Optional. | ||
| ``` |
Oops, something went wrong.