From c4d5c1a45475abe91ccca11c149d899db39f1384 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Thu, 18 Apr 2024 17:16:15 -0400 Subject: [PATCH] polish dynamic secrets docs --- .../platform/dynamic-secrets/mysql.mdx | 31 +++++++----- .../platform/dynamic-secrets/oracle.mdx | 47 ++++++++++-------- .../platform/dynamic-secrets/postgresql.mdx | 49 +++++++++++-------- 3 files changed, 75 insertions(+), 52 deletions(-) diff --git a/docs/documentation/platform/dynamic-secrets/mysql.mdx b/docs/documentation/platform/dynamic-secrets/mysql.mdx index b534f4928..c64edab63 100644 --- a/docs/documentation/platform/dynamic-secrets/mysql.mdx +++ b/docs/documentation/platform/dynamic-secrets/mysql.mdx @@ -62,47 +62,54 @@ Create a user with the required permission in your SQL instance. This user will A CA may be required if your DB requires it for incoming connections. AWS RDS instances with default settings will requires a CA which can be downloaded [here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html#UsingWithRDS.SSL.CertificatesAllRegions). - ![Dynamic Secret Setup Modal](/images/platform/dynamic-secrets/dynamic-secret-setup-modal-mysql.png) - - If you want to provide specific privileges for the generated dynamic credentials, you can modifythe SQL statement to your needs. + If you want to provide specific privileges for the generated dynamic credentials, you can modify the SQL statement to your needs. This is useful if you want to only give access to a specific table(s). ![Modify SQL Statements Modal](/images/platform/dynamic-secrets/modify-sql-statement-mysql.png) - After submitting the form, you will see a dynamic secret creates in the dashboard. + After submitting the form, you will see a dynamic secret created in the dashboard. - If this step fails, you might have to add the CA certficate. + If this step fails, you may have to add the CA certificate. ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret.png) - Once you've successfully created the dynamic secret, you're all set to generate unique secret values. To do this, simply click on the Generate button located in the respective row. Alternatively, you can initiate the creation of a new lease by selecting New Leases from the dynamic secret lease list section, accessible by clicking on the relevant row. + Once you've successfully configured the dynamic secret, you're ready to generate on-demand credentials. + To do this, simply click on the 'Generate' button which appears when hovering over the dynamic secret item. + Alternatively, you can initiate the creation of a new lease by selecting 'New Lease' from the dynamic secret lease list section. ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-generate.png) ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-lease-empty.png) - When generating these secrets, it's important to specify a Time-to-Live (TTL) duration within the predefined range. Ensure that the TTL falls within the maximum TTL defined in the previous step to maintain consistency and security. + When generating these secrets, it's important to specify a Time-to-Live (TTL) duration. This will dictate how long the credentials are valid for. ![Provision Lease](/images/platform/dynamic-secrets/provision-lease.png) - After you click the `Submit` button, a new secret lease will be generated and the Database User and Database Password will be shown. + + Ensure that the TTL for the lease fall within the maximum TTL defined when configuring the dynamic secret. + + + + Once you click the `Submit` button, a new secret lease will be generated and the credentials from it will be shown to you. ![Provision Lease](/images/platform/dynamic-secrets/lease-values.png) ## Audit or Revoke Leases -As soon as you have generated a few secret leases, you will be able to access them by clicking on the respective dynamic secret row. In this modal, you are able to see the expiration time or delete a secret preemptively. +Once you have created one or more leases, you will be able to access them by clicking on the respective dynamic secret item on the dashboard. +This will allow you see the expiration time of the lease or delete a lease before it's set time to live. ![Provision Lease](/images/platform/dynamic-secrets/lease-data.png) ## Renew Leases - +To extend the life of the generated dynamic secret leases past its initial time to live, simply click on the **Renew** as illustrated below. ![Provision Lease](/images/platform/dynamic-secrets/dynamic-secret-lease-renew.png) -To extend the expiration of generated dynamic secret leases, simply click on the **Renew** button located above, as illustrated. This action also allows for an extension of the Time-to-Live (TTL). -However, it's crucial to note that the expiry cannot exceed the maximum TTL from created, specified in the configuration settings. + + Lease renewals cannot exceed the maximum TTL set when configuring the dynamic secret + \ No newline at end of file diff --git a/docs/documentation/platform/dynamic-secrets/oracle.mdx b/docs/documentation/platform/dynamic-secrets/oracle.mdx index a17f3b156..05b832c4f 100644 --- a/docs/documentation/platform/dynamic-secrets/oracle.mdx +++ b/docs/documentation/platform/dynamic-secrets/oracle.mdx @@ -15,7 +15,7 @@ Create a user with the required permission in your SQL instance. This user will Open the Secret Overview dashboard and select the environment in which you would like to add a dynamic secret. - + ![Add Dynamic Secret Button](../../../images/platform/dynamic-secrets/add-dynamic-secret-button.png) @@ -66,43 +66,50 @@ Create a user with the required permission in your SQL instance. This user will - If you want to provide specific privileges for the future generated dynamic secrets, you are able to specify them as SQL statements. - - ![Modify SQL Statements Modal](../../../images/platform/dynamic-secrets/modify-sql-statements-oracle.png) + If you want to provide specific privileges for the generated dynamic credentials, you can modify the SQL statement to your needs. This is useful if you want to only give access to a specific table(s). - - After submitting the form, you will see a dynamic secret creates in the dashboard. + + After submitting the form, you will see a dynamic secret created in the dashboard. - If this step fails, you might have to add the CA certficate. + If this step fails, you may have to add the CA certficate. ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret.png) - Once you've successfully created the dynamic secret, you're all set to generate unique secret values. To do this, simply click on the Generate button located in the respective row. Alternatively, you can initiate the creation of a new lease by selecting New Leases from the dynamic secret lease list section, accessible by clicking on the relevant row. + Once you've successfully configured the dynamic secret, you're ready to generate on-demand credentials. + To do this, simply click on the 'Generate' button which appears when hovering over the dynamic secret item. + Alternatively, you can initiate the creation of a new lease by selecting 'New Lease' from the dynamic secret lease list section. - ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret-generate.png) - ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret-lease-empty.png) + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-generate.png) + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-lease-empty.png) - When generating these secrets, it's important to specify a Time-to-Live (TTL) duration within the predefined range. Ensure that the TTL falls within the maximum TTL defined in the previous step to maintain consistency and security. + When generating these secrets, it's important to specify a Time-to-Live (TTL) duration. This will dictate how long the credentials are valid for. - ![Provision Lease](../../../images/platform/dynamic-secrets/provision-lease.png) + ![Provision Lease](/images/platform/dynamic-secrets/provision-lease.png) - After you click the `Submit` button, a new secret lease will be generated and the Database User and Database Password will be shown. + + Ensure that the TTL for the lease fall within the maximum TTL defined when configuring the dynamic secret. + - ![Provision Lease](../../../images/platform/dynamic-secrets/lease-values.png) + + Once you click the `Submit` button, a new secret lease will be generated and the credentials for it will be shown to you. + + ![Provision Lease](/images/platform/dynamic-secrets/lease-values.png) ## Audit or Revoke Leases -As soon as you have generated a few secret leases, you will be able to access them by clicking on the respective dynamic secret row. In this modal, you are able to see the expiration time or delete a secret preemptively. +Once you have created one or more leases, you will be able to access them by clicking on the respective dynamic secret item on the dashboard. +This will allow you see the expiration time of the lease or delete a lease before it's set time to live. -![Provision Lease](../../../images/platform/dynamic-secrets/lease-data.png) +![Provision Lease](/images/platform/dynamic-secrets/lease-data.png) ## Renew Leases +To extend the life of the generated dynamic secret leases past its initial time to live, simply click on the **Renew** as illustrated below. +![Provision Lease](/images/platform/dynamic-secrets/dynamic-secret-lease-renew.png) -![Provision Lease](../../../images/platform/dynamic-secrets/dynamic-secret-lease-renew.png) - -To extend the expiration of generated dynamic secret leases, simply click on the **Renew** button located above, as illustrated. This action also allows for an extension of the Time-to-Live (TTL). -However, it's crucial to note that the expiry cannot exceed the maximum TTL from created, specified in the configuration settings. + + Lease renewals cannot exceed the maximum TTL set when configuring the dynamic secret + \ No newline at end of file diff --git a/docs/documentation/platform/dynamic-secrets/postgresql.mdx b/docs/documentation/platform/dynamic-secrets/postgresql.mdx index c5e0d5ef8..78ba87ee5 100644 --- a/docs/documentation/platform/dynamic-secrets/postgresql.mdx +++ b/docs/documentation/platform/dynamic-secrets/postgresql.mdx @@ -1,9 +1,9 @@ --- title: "PostgreSQL" -description: "Learn how to dynamically generate PostgreSQL Database user passwords." +description: "How to dynamically generate PostgreSQL database users" --- -The Infisical PostgreSQL dynamic secret allows you to generate PostgreSQL Database credentials on demand based on configured role. +The Infisical PostgreSQL dynamic secret allows you to generate PostgreSQL database credentials on demand based on configured role. ## Prerequisite @@ -16,7 +16,7 @@ Create a user with the required permission in your SQL instance. This user will Open the Secret Overview dashboard and select the environment in which you would like to add a dynamic secret. - + ![Add Dynamic Secret Button](../../../images/platform/dynamic-secrets/add-dynamic-secret-button.png) @@ -67,43 +67,52 @@ Create a user with the required permission in your SQL instance. This user will - If you want to provide specific privileges for the future generated dynamic secrets, you are able to specify them as SQL statements. + If you want to provide specific privileges for the generated dynamic credentials, you can modify the SQL statement to your needs. This is useful if you want to only give access to a specific table(s). ![Modify SQL Statements Modal](../../../images/platform/dynamic-secrets/modify-sql-statements.png) - - After submitting the form, you will see a dynamic secret creates in the dashboard. + + After submitting the form, you will see a dynamic secret created in the dashboard. - If this step fails, you might have to add the CA certficate. + If this step fails, you may have to add the CA certficate. ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret.png) - Once you've successfully created the dynamic secret, you're all set to generate unique secret values. To do this, simply click on the Generate button located in the respective row. Alternatively, you can initiate the creation of a new lease by selecting New Leases from the dynamic secret lease list section, accessible by clicking on the relevant row. + Once you've successfully configured the dynamic secret, you're ready to generate on-demand credentials. + To do this, simply click on the 'Generate' button which appears when hovering over the dynamic secret item. + Alternatively, you can initiate the creation of a new lease by selecting 'New Lease' from the dynamic secret lease list section. - ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret-generate.png) - ![Dynamic Secret](../../../images/platform/dynamic-secrets/dynamic-secret-lease-empty.png) + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-generate.png) + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-lease-empty.png) - When generating these secrets, it's important to specify a Time-to-Live (TTL) duration within the predefined range. Ensure that the TTL falls within the maximum TTL defined in the previous step to maintain consistency and security. + When generating these secrets, it's important to specify a Time-to-Live (TTL) duration. This will dictate how long the credentials are valid for. - ![Provision Lease](../../../images/platform/dynamic-secrets/provision-lease.png) + ![Provision Lease](/images/platform/dynamic-secrets/provision-lease.png) - After you click the `Submit` button, a new secret lease will be generated and the Database User and Database Password will be shown. + + Ensure that the TTL for the lease fall within the maximum TTL defined when configuring the dynamic secret. + - ![Provision Lease](../../../images/platform/dynamic-secrets/lease-values.png) + + Once you click the `Submit` button, a new secret lease will be generated and the credentials for it will be shown to you. + + ![Provision Lease](/images/platform/dynamic-secrets/lease-values.png) ## Audit or Revoke Leases -As soon as you have generated a few secret leases, you will be able to access them by clicking on the respective dynamic secret row. In this modal, you are able to see the expiration time or delete a secret preemptively. +Once you have created one or more leases, you will be able to access them by clicking on the respective dynamic secret item on the dashboard. +This will allow you see the expiration time of the lease or delete the lease before it's set time to live. -![Provision Lease](../../../images/platform/dynamic-secrets/lease-data.png) +![Provision Lease](/images/platform/dynamic-secrets/lease-data.png) ## Renew Leases +To extend the life of the generated dynamic secret leases past its initial time to live, simply click on the **Renew** as illustrated below. +![Provision Lease](/images/platform/dynamic-secrets/dynamic-secret-lease-renew.png) -![Provision Lease](../../../images/platform/dynamic-secrets/dynamic-secret-lease-renew.png) - -To extend the expiration of generated dynamic secret leases, simply click on the **Renew** button located above, as illustrated. This action also allows for an extension of the Time-to-Live (TTL). -However, it's crucial to note that the expiry cannot exceed the maximum TTL from created, specified in the configuration settings. + + Lease renewals cannot exceed the maximum TTL set when configuring the dynamic secret + \ No newline at end of file