diff --git a/modules/eso-clusterstore/README.md b/modules/eso-clusterstore/README.md index f09d7dea..3c0a9e6e 100644 --- a/modules/eso-clusterstore/README.md +++ b/modules/eso-clusterstore/README.md @@ -10,6 +10,24 @@ This module supports ClusterSecretStore two authentication configurations to pul For more information about Trusted Profiles refer to the IBM Cloud documentation available [here](https://cloud.ibm.com/docs/account?topic=account-create-trusted-profile&interface=ui) +## Usage + +```hcl +# Replace "master" with a GIT release version to lock into a specific release +module "eso_clusterstore" { + source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-external-secrets-operator.git//modules/eso-clusterstore?ref=master" + eso_authentication = "api_key" + clusterstore_secret_apikey = data.ibm_sm_iam_credentials_secret.secret_puller_secret.api_key # pragma: allowlist secret + region = local.sm_region + clusterstore_helm_rls_name = "cluster-store" + clusterstore_secret_name = "generic-cluster-api-key" + clusterstore_name = "cluster-store" + clusterstore_secrets_manager_guid = local.sm_guid + eso_namespace = var.eso_namespace + service_endpoints = var.service_endpoints +} +``` + ### Requirements diff --git a/modules/eso-external-secret/README.md b/modules/eso-external-secret/README.md index 99e258fa..2e54d9a2 100644 --- a/modules/eso-external-secret/README.md +++ b/modules/eso-external-secret/README.md @@ -9,6 +9,23 @@ by correctly setting the related input variable `eso_store_scope` For more information about ExternalSecrets on ESO please refer to the ESO documentation available [here](https://external-secrets.io/v0.8.3/guides/introduction/) +## Usage + +```hcl +# Replace "master" with a GIT release version to lock into a specific release +module "external_secret_usr_pass" { + source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-external-secrets-operator.git//modules/eso-external-secret?ref=master" + es_kubernetes_secret_type = "dockerconfigjson" + sm_secret_type = "username_password" + sm_secret_id = module.sm_userpass_secret.secret_id + es_kubernetes_namespace = kubernetes_namespace.apikey_namespaces[0].metadata[0].name + eso_store_name = "cluster-store" + es_container_registry = "example-registry-local.artifactory.com" + es_kubernetes_secret_name = "dockerconfigjson-uc" + es_helm_rls_name = "es-docker-uc" +} +``` + ### Requirements diff --git a/modules/eso-secretstore/README.md b/modules/eso-secretstore/README.md index 729c7318..d20bc175 100644 --- a/modules/eso-secretstore/README.md +++ b/modules/eso-secretstore/README.md @@ -10,6 +10,24 @@ This module supports SecretStore two authentication configurations to pull/push For more information about Trusted Profiles refer to the IBM Cloud documentation available [here](https://cloud.ibm.com/docs/account?topic=account-create-trusted-profile&interface=ui) +## Usage + +```hcl +# Replace "master" with a GIT release version to lock into a specific release +module "eso_apikey_secretstore" { + source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-external-secrets-operator.git//modules/eso-secretstore?ref=master" + eso_authentication = "api_key" + region = local.sm_region + sstore_namespace = kubernetes_namespace.apikey_namespaces.metadata[0].name + sstore_secrets_manager_guid = local.sm_guid + sstore_store_name = "${var.es_namespaces_apikey}-store" + sstore_secret_apikey = data.ibm_sm_iam_credentials_secret.secret_puller_secret.api_key # pragma: allowlist secret + service_endpoints = var.service_endpoints + sstore_helm_rls_name = "es-store" + sstore_secret_name = "generic-cluster-api-key" +} +``` + ### Requirements diff --git a/modules/eso-trusted-profile/README.md b/modules/eso-trusted-profile/README.md index cf8957fd..7753eee1 100644 --- a/modules/eso-trusted-profile/README.md +++ b/modules/eso-trusted-profile/README.md @@ -4,6 +4,21 @@ This module allows to create and configure an Trusted Profile to authenticate wi For more information about Trusted Profiles refer to the IBM Cloud documentation available [here](https://cloud.ibm.com/docs/account?topic=account-create-trusted-profile&interface=ui) +## Usage + +```hcl +# Replace "master" with a GIT release version to lock into a specific release +module "clusterstore_trusted_profile" { + source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-external-secrets-operator.git//modules/eso-trusted-profile?ref=master" + trusted_profile_name = local.cstore_trusted_profile_name + secrets_manager_guid = local.sm_guid + secret_groups_id = [module.tp_clusterstore_secrets_manager_group.secret_group_id] + tp_cluster_crn = module.ocp_base.cluster_crn + trusted_profile_claim_rule_type = "ROKS_SA" + tp_namespace = var.eso_namespace +} +``` + ### Requirements