From 13894261cef9050675664f75755f62db596e4721 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Fri, 10 Jan 2025 20:10:00 +0100 Subject: [PATCH 1/3] docs: small k8s docs improvements --- .../kubernetes/infisical-dynamic-secret-crd.mdx | 2 +- .../platforms/kubernetes/infisical-push-secret-crd.mdx | 10 +++++++++- .../platforms/kubernetes/infisical-secret-crd.mdx | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx index 9bdb43e6a..637e662bb 100644 --- a/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx @@ -1,6 +1,6 @@ --- sidebarTitle: "InfisicalDynamicSecret CRD" -title: "InfisicalDynamicSecret CRD" +title: "Using the InfisicalDynamicSecret CRD" description: "Learn how to generate dynamic secret leases in Infisical and sync them to your Kubernetes cluster." --- ## Overview diff --git a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx index eb226e7b8..d3427cfe3 100644 --- a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx @@ -5,7 +5,15 @@ description: "Learn how to use the InfisicalPushSecret CRD to push and manage se --- -## Push Secrets to Infisical +## Overview + +The **InfisicalPushSecret** CRD allows you to create and manage secrets in Infisical and sync them to your Kubernetes cluster as native **Kubernetes secret** resources. +If you need automatic redeployments of your application when secrets change, you can use the [InfisicalSecret](/docs/integrations/platforms/kubernetes/infisical-secret-crd) CRD to fetch secrets from Infisical and inject them into your application's environment. + + +This CRD offers the following features: +- **Create Secrets** in Infisical and manage its lifecycle. +- **Automatic secret deletion** when the InfisicalPushSecret CRD is deleted. ### Example usage diff --git a/docs/integrations/platforms/kubernetes/infisical-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-secret-crd.mdx index 39154a7c4..f263b518a 100644 --- a/docs/integrations/platforms/kubernetes/infisical-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-secret-crd.mdx @@ -1,6 +1,6 @@ --- sidebarTitle: "InfisicalSecret CRD" -title: "InfisicalSecret CRD" +title: "Using the InfisicalSecret CRD" description: "Learn how to use the InfisicalSecret CRD to fetch secrets from Infisical and store them as native Kubernetes secret resource" --- From 956fb2efb4b3dd06500d0c43f52692999c9b8667 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Fri, 10 Jan 2025 20:16:30 +0100 Subject: [PATCH 2/3] docs: better k8s pre-req --- .../kubernetes/infisical-dynamic-secret-crd.mdx | 6 ++++-- .../kubernetes/infisical-push-secret-crd.mdx | 11 ++++++++--- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx index 637e662bb..f06ef6f72 100644 --- a/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-dynamic-secret-crd.mdx @@ -15,8 +15,10 @@ This CRD offers the following features: - **Optionally trigger redeployments** of any workloads that consume the secret if you enable auto-reload. ### Prerequisites -- The operator is installed on to your Kubernetes cluster -- You have already configured a dynamic secret in Infisical +- A project within Infisical. +- A [machine identity](/docs/documentation/platform/identities/overview) ready for use in Infisical that has permissions to create dynamic secret leases in the project. +- You have already configured a dynamic secret in Infisical. +- The operator is installed on to your Kubernetes cluster. ## Configure Dynamic Secret CRD diff --git a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx index d3427cfe3..178b8059b 100644 --- a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx @@ -15,8 +15,13 @@ This CRD offers the following features: - **Create Secrets** in Infisical and manage its lifecycle. - **Automatic secret deletion** when the InfisicalPushSecret CRD is deleted. +### Prerequisites -### Example usage +- A project within Infisical. +- A [machine identity](/docs/documentation/platform/identities/overview) ready for use in Infisical that has permissions to create secrets in your project. +- The operator is installed on to your Kubernetes cluster. + +## Example usage Below is a sample InfisicalPushSecret CRD that pushes secrets defined in a Kubernetes secret to Infisical. @@ -97,7 +102,7 @@ After applying the soruce-secret.yaml file, you are ready to apply the Infisical After applying the InfisicalPushSecret CRD, you should notice that the secrets you have defined in your source-secret.yaml file have been pushed to your specified destination in Infisical. -### InfisicalPushSecret CRD properties +## InfisicalPushSecret CRD properties If you are fetching secrets from a self-hosted instance of Infisical set the value of `hostAPI` to @@ -397,7 +402,7 @@ After applying the InfisicalPushSecret CRD, you should notice that the secrets y -### Applying the InfisicalPushSecret CRD to your cluster +## Applying the InfisicalPushSecret CRD to your cluster Once you have configured the `InfisicalPushSecret` CRD with the required fields, you can apply it to your cluster. After applying, you should notice that the secrets have been pushed to Infisical. From 6487c83bda889f56630d4d6f9785ee3a05d07335 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Mon, 13 Jan 2025 14:35:36 +0100 Subject: [PATCH 3/3] docs: requested changes --- .../kubernetes/infisical-push-secret-crd.mdx | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx index 178b8059b..67fc7f2a8 100644 --- a/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx +++ b/docs/integrations/platforms/kubernetes/infisical-push-secret-crd.mdx @@ -7,13 +7,12 @@ description: "Learn how to use the InfisicalPushSecret CRD to push and manage se ## Overview -The **InfisicalPushSecret** CRD allows you to create and manage secrets in Infisical and sync them to your Kubernetes cluster as native **Kubernetes secret** resources. -If you need automatic redeployments of your application when secrets change, you can use the [InfisicalSecret](/docs/integrations/platforms/kubernetes/infisical-secret-crd) CRD to fetch secrets from Infisical and inject them into your application's environment. +The **InfisicalPushSecret** CRD allows you to create secrets in your Kubernetes cluster and push them to Infisical. This CRD offers the following features: -- **Create Secrets** in Infisical and manage its lifecycle. -- **Automatic secret deletion** when the InfisicalPushSecret CRD is deleted. +- **Push Secrets** from a Kubernetes secret into Infisical. +- **Manage secret lifecycle** of pushed secrets in Infisical. When the Kubernetes secret is updated, the operator will automatically update the secrets in Infisical. Optionally, when the Kubernetes secret is deleted, the operator will delete the secrets in Infisical automatically. ### Prerequisites @@ -285,7 +284,7 @@ After applying the InfisicalPushSecret CRD, you should notice that the secrets y - The Kubernetes machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalSecret resource. This authentication method can only be used within a Kubernetes environment. + The Kubernetes machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalPushSecret resource. This authentication method can only be used within a Kubernetes environment. [Read more about Kubernetes Auth](/documentation/platform/identities/kubernetes-auth). Valid fields: - `identityId`: The identity ID of the machine identity you created. @@ -339,7 +338,7 @@ After applying the InfisicalPushSecret CRD, you should notice that the secrets y ``` - The GCP IAM machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalSecret resource. This authentication method can only be used both within and outside GCP environments. + The GCP IAM machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalPushSecret resource. This authentication method can only be used both within and outside GCP environments. [Read more about Azure Auth](/documentation/platform/identities/gcp-auth). @@ -357,7 +356,7 @@ After applying the InfisicalPushSecret CRD, you should notice that the secrets y ``` - The GCP ID Token machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalSecret resource. This authentication method can only be used within GCP environments. + The GCP ID Token machine identity authentication method is used to authenticate with Infisical. The identity ID is stored in a field in the InfisicalPushSecret resource. This authentication method can only be used within GCP environments. [Read more about Azure Auth](/documentation/platform/identities/gcp-auth). Valid fields: