Skip to content

Latest commit

 

History

History
797 lines (582 loc) · 30.4 KB

aws-secrets-manager.hbs.md

File metadata and controls

797 lines (582 loc) · 30.4 KB
Raw

Install Tanzu Application Platform through GitOps with AWS Secrets Manager

Caution Tanzu Application Platform (GitOps) is currently in beta and is intended for evaluation and test purposes only. Do not use in a production environment.

This topic tells you how to install Tanzu Application Platform (commonly known as TAP) through GitOps with secrets managed externally in AWS Secrets Manager. To decide which approach to use, see Choosing Secrets OPerationS (SOPS) or External Secrets Operator (ESO).

Tanzu GitOps Reference Implementation (RI) does not support changing the secrets management strategy for a cluster, for example, SOPS to ESO. However, changing between AWS Secrets Manager and HashiCorp Vault is supported. The External Secrets Operator integration in this release of Tanzu GitOps RI is verified to support AWS Elastic Kubernetes Service (EKS) cluster with AWS Secrets Manager. Other combinations of Kubernetes distribution and ESO providers are not verified.

Prerequisites

Before installing Tanzu Application Platform, ensure you have:

Relocate images to a registry

VMware recommends relocating the images from VMware Tanzu Network registry to your own container image registry before attempting installation. If you don't relocate the images, Tanzu Application Platform depends on VMware Tanzu Network for continued operation, and VMware Tanzu Network offers no uptime guarantees. The option to skip relocation is documented for evaluation and proof-of-concept only.

The supported registries are Harbor, Azure Container Registry, Google Container Registry, and Quay.io. See the following the documentation for instructions on setting up a registry:

To relocate images from the VMware Tanzu Network registry to your registry:

  1. Set up environment variables for installation use by running:

    export IMGPKG_REGISTRY_HOSTNAME_0=registry.tanzu.vmware.com
export IMGPKG_REGISTRY_USERNAME_0=MY-TANZUNET-USERNAME
export IMGPKG_REGISTRY_PASSWORD_0=MY-TANZUNET-PASSWORD
export IMGPKG_REGISTRY_HOSTNAME_1=MY-REGISTRY
export IMGPKG_REGISTRY_USERNAME_1=MY-REGISTRY-USER
export IMGPKG_REGISTRY_PASSWORD_1=MY-REGISTRY-PASSWORD
export INSTALL_REGISTRY_USERNAME=MY-REGISTRY-USER
export INSTALL_REGISTRY_PASSWORD=MY-REGISTRY-PASSWORD
export INSTALL_REGISTRY_HOSTNAME=MY-REGISTRY
export TAP_VERSION=VERSION-NUMBER
export INSTALL_REPO=TARGET-REPOSITORY

    Where:

    • MY-REGISTRY-USER is the user with write access to MY-REGISTRY.
    • MY-REGISTRY-PASSWORD is the password for MY-REGISTRY-USER.
    • MY-REGISTRY is your own container registry.
    • MY-TANZUNET-USERNAME is the user with access to the images in the VMware Tanzu Network registry registry.tanzu.vmware.com.
    • MY-TANZUNET-PASSWORD is the password for MY-TANZUNET-USERNAME.
    • VERSION-NUMBER is your Tanzu Application Platform version. For example, {{ vars.tap_version }}.
    • TARGET-REPOSITORY is your target repository, a folder or repository on MY-REGISTRY that serves as the location for the installation files for Tanzu Application Platform.

    VMware recommends using a JSON key file to authenticate with Google Container Registry. In this case, the value of INSTALL_REGISTRY_USERNAME is _json_key and the value of INSTALL_REGISTRY_PASSWORD is the content of the JSON key file. For more information about how to generate the JSON key file, see Google Container Registry documentation.

  2. [Install the Carvel tool imgpkg CLI](https://docs.vmware.com/en/Cluster-Essentials-for-VMware-Tanzu/{{ vars.url_version }}/cluster-essentials/deploy.html#optionally-install-clis-onto-your-path-6).

    To query for the available versions of Tanzu Application Platform on VMWare Tanzu Network Registry, run:

    imgpkg tag list -i registry.tanzu.vmware.com/tanzu-application-platform/tap-packages | sort -V

  3. Relocate the images with the imgpkg CLI by running:

    imgpkg copy -b registry.tanzu.vmware.com/tanzu-application-platform/tap-packages:${TAP_VERSION} --to-repo ${INSTALL_REGISTRY_HOSTNAME}/${INSTALL_REPO}/tap-packages

(Optional) Install Tanzu Application Platform in an air-gapped environment

Complete the following steps if you install Tanzu Application Platform in an air-gapped environment:

  1. Relocate the Tanzu Build Service images to your registry:

    imgpkg copy -b registry.tanzu.vmware.com/tanzu-application-platform/full-tbs-deps-package-repo:VERSION --to-repo ${INSTALL_REGISTRY_HOSTNAME}/${INSTALL_REPO}/full-tbs-deps-package-repo

    Where VERSION is the version of Tanzu Build Service. You can retrieve this value by running kubectl get package -n tap-install | grep buildservice

  2. Configure custom certificate authorities for Tanzu Developer Portal.

  3. Host a grype database in the air-gapped environment. For more information, see Use Grype in offline and air-gapped environments.

Create a new Git repository

Follow these steps to create a new Git repository:

  1. In a hosted Git service, for example, GitHub or GitLab, create a new repository.

    This version of Tanzu GitOps RI supports authenticating to a hosted Git repository by using SSH and Basic Authentication.

  2. Initialize a new Git repository:

    mkdir -p $HOME/tap-gitops
cd $HOME/tap-gitops

git init
git remote add origin git@github.com:my-organization/tap-gitops.git

  3. Set up the authentication method:

    SSH : Create a read-only deploy key for this new repository (recommended) or SSH key for an account with read access to this repository. The private portion of this key is referred to as GIT_SSH_PRIVATE_KEY.

    Basic Authentication : Have a user name with read access to the Git repository and password or personal access token for the same user.

    Important Only use one of ssh or Basic Authentication, not both.

Download and unpack Tanzu GitOps Reference Implementation (RI)

Follow these steps to download and unpack Tanzu GitOps Reference Implementation (RI):

  1. Sign in to VMware Tanzu Network.

  2. Go to the Tanzu Application Platform product page.

  3. Select Release {{ vars.tap_version }} from the release drop-down menu.

  4. Click Tanzu GitOps Reference Implementation.

  5. Unpack the downloaded TGZ file into the $HOME/tap-gitops directory by running:

    tar -xvf tanzu-gitops-ri-*.tgz -C $HOME/tap-gitops

  6. Commit the initial state:

    cd $HOME/tap-gitops

git add . && git commit -m "Initialize Tanzu GitOps RI"
git push -u origin

Create your cluster configuration

Follow these steps to create your cluster configuration:

  1. Seed configuration for a cluster by using the provided convenience script:

    cd $HOME/tap-gitops

./setup-repo.sh CLUSTER-NAME aws-secrets-manager

    Where:

    • CLUSTER-NAME is the name for your cluster. Typically, this is the same as your EKS cluster's name, the name of the cluster as it appears in eksctl get clusters
    • aws-secrets-manager selects the AWS Secrets Manager external Secret Store.

    For example, if the name of your cluster is iterate-green:

    cd $HOME/tap-gitops

./setup-repo.sh iterate-green aws-secrets-manager

    This script creates the directory clusters/iterate-green/ and copies in the configuration required to sync this Git repository with the cluster and installing Tanzu Application Platform.

  2. Commit and push:

    git add . && git commit -m 'Add "iterate-green" cluster'
git push

    Saving the base configuration in an initial commit makes it easier to review customizations in the future.

Customize your cluster configuration

Configuring the Tanzu Application Platform installation involves setting up two components:

  • An installation of Tanzu Application Platform.
  • An instance of Tanzu Sync, the component that implements the GitOps workflow, fetching configuration from Git and applying it to the cluster.

Follow these steps to customize your Tanzu Application Platform cluster configuration:

  1. Navigate to the created directory:

    cd clusters/CLUSTER-NAME

    For example, if the name of your cluster is iterate-green:

    cd clusters/iterate-green

  2. Define the following environment variables:

    export AWS_ACCOUNT_ID=MY-AWS-ACCOUNT-ID
export AWS_REGION=AWS-REGION
export CLUSTER_NAME=CLUSTER-NAME
export TAP_PKGR_REPO=TAP-PACKAGE-OCI-REPOSITORY

    Where:

    • MY-AWS-ACCOUNT-ID is your AWS account ID as it appears in the output of aws sts get-caller-identity.
    • AWS-REGION is the region where the Secrets Manager is and the EKS cluster was created.
    • CLUSTER-NAME is the name of the target cluster as it appears in the output of eksctl get clusters.
    • TAP-PACKAGE-OCI-REPOSITORY is the fully-qualified path to the OCI repository hosting the Tanzu Application Platform images. If they are relocated to a different registry as described in Relocate images to a registry, the value is ${INSTALL_REGISTRY_HOSTNAME}/${INSTALL_REPO}/tap-packages.

Grant read access to secret data

AWS Secrets Manager secrets store all sensitive configurations, which are accessed by both Tanzu Sync and the Tanzu Application Platform installation.

Follow these steps to configure the IAM Role for a Service Account:

  1. In AWS Identity and Access Manager, create two IAM Policies, one to read the Tanzu Sync secrets and another to read the Tanzu Application Platform installation secrets, by using the supplied script:

    tanzu-sync/scripts/setup/create-policies.sh

  2. Create two IAM Role-to-Service Account pairs for your cluster, one for Tanzu Sync and another for the Tanzu Application Platform installation, by using the supplied script:

    tanzu-sync/scripts/setup/create-irsa.sh

    For example, if the name of the EKS cluster is iterate-green using the defaults, there are two IAM roles in the AWS account:

    $ aws iam list-roles --query 'Roles[?starts_with(RoleName,`iterate-green`)]'
[
   {
       "RoleName": "iterate-green--tanzu-sync-secrets",
       ...
   },
   {
       "RoleName": "iterate-green--tap-install-secrets",
       ...
   }
]

Generate the default configuration

You can use the following script to generate the default configuration for both Tanzu Sync and Tanzu Application Platform installation:

tanzu-sync/scripts/configure.sh

The following sections tell you how to edit the configuration values to suit your specific needs.

Review and store Tanzu Sync config

Configuration for Tanzu is stored in two locations:

  • Sensitive configuration is stored in AWS Secrets Manager.
  • Non-sensitive configuration are stored in YAML files in the Git repository.

Follow these steps to create the sensitive configuration and review the non-sensitive configuration:

  1. Save the credentials that Tanzu Sync uses to authenticate with the Git repository.

    SSH : Create a secret named dev/CLUSTER-NAME/tanzu-sync/sync-git/ssh containing the following information as plaintext:

     ```json
 {
   "privatekey": "... (private key portion here) ...",
   "knownhosts": "... (known_hosts for git host here) ..."
 }
 ```

 Where `CLUSTER-NAME` is the name as it appears in `eksctl get clusters`.

 For example, if the Git repository is hosted on GitHub, and the private key
 created in [Create a new Git repository](#create-a-new-git-repository) is stored in the file `~/.ssh/id_ed25519`:

 ```console
 aws secretsmanager create-secret \
   --name dev/${CLUSTER_NAME}/tanzu-sync/sync-git/ssh \
   --secret-string "$(cat <<EOF
 {
   "privatekey": "$(cat ~/.ssh/id_ed25519 | awk '{printf "%s\\\\n", $0}')",
   "knownhosts": "$(ssh-keyscan github.com | awk '{printf "%s\\\\n", $0}')"
 }
 EOF
 )"
 ```

 Where:

 - The content of `~/.ssh/id_ed25519` is the private portion of the SSH key.
 - `ssh-keyscan` obtains the public keys for the SSH host.
 - `awk '{printf "%s\\n", $0}'` converts a multiline string into a single-line
 string with embedded newline chars (`\n`). JSON does not support multiline strings.

    Basic Authentication : Create a secret named dev/CLUSTER-NAME/tanzu-sync/sync-git/basic_auth containing the following information as plaintext:

     ```json
 {
   "username": "... (username) ...",
   "password": "... (password) ..."
 }
 ```

 Where:

 - `CLUSTER-NAME` is the name as it appears in `eksctl get clusters`.
 - `username` is the username of a user account with read access to the Git repository.
 - `password` is the password or personal access token for the user.

  2. To securely store the authentication credentials required for accessing the OCI registry that hosts the Tanzu Application Platform images, create a secret called dev/CLUSTER-NAME/tanzu-sync/install-registry-dockerconfig. This secret contains the following information in plaintext:

    {
  "auths": {
    "MY-REGISTRY": {
      "username": "MY-REGISTRY-USER",
      "password": "MY-REGISTRY-PASSWORD"
    }
  }
}

    Where:

    • CLUSTER-NAME is the name as it appears in eksctl get clusters
    • MY-REGISTRY-USER is the user with write access to MY-REGISTRY.
    • MY-REGISTRY-PASSWORD is the password for MY-REGISTRY-USER.
    • MY-REGISTRY is the container registry where the Tanzu Application Platform images are located.

    For example:

    aws secretsmanager create-secret \
   --name dev/${CLUSTER_NAME}/tanzu-sync/install-registry-dockerconfig \
   --secret-string "$(cat <<EOF
{
 "auths": {
   "${INSTALL_REGISTRY_HOSTNAME}": {
     "username": "${INSTALL_REGISTRY_USERNAME}",
     "password": "${INSTALL_REGISTRY_PASSWORD}"
   }
 }
}
EOF
)"

  3. Review the hosted Git URL and branch used by Tanzu Sync.

    This configuration was generated by the configure.sh script. It reported:

    ...
wrote non-sensitive Tanzu Sync configuration to: tanzu-sync/app/values/tanzu-sync.yaml
...

    For example, for the iterate-green cluster, if the Git repository is hosted on GitHub under my-organization/tap-gitops and is on the main branch, tanzu-sync.yaml contains the following information:

    ---
git:
 url: git@github.com:my-organization/tap-gitops.git
 ref: origin/main
 sub_path: clusters/iterate-green/cluster-config

    You can review and edit these values as needed.

  4. Review the integration with External Secrets Operator.

    This configuration was generated by the configure.sh script. It reported:

    ...
wrote ESO configuration for Tanzu Sync to: tanzu-sync/app/values/tanzu-sync-aws-secrets-manager-values.yaml
...

    For example, for the iterate-green cluster, if the AWS account is 665100000000, tanzu-sync-aws-secrets-manager-values.yaml contains the following information:

    ---
secrets:
 eso:
   aws:
     region: us-west-2
     tanzu_sync_secrets:
       role_arn: arn:aws:iam::665100000000:role/iterate-green--tanzu-sync-secrets
   remote_refs:
     sync_git:
     # TO DO: Fill in your configuration for ssh or basic authentication here. See tanzu-sync/app/config/.tanzu-managed/schema--eso.yaml for details.
     install_registry_dockerconfig:
       dockerconfigjson:
         key: dev/iterate-green/tanzu-sync/install-registry-dockerconfig

    Where:

    • role_arn is the IAM role that grants permission to Tanzu Sync to read secrets specific to Tanzu Sync. This role was created in the Grant read access to secret data section.
    • install_registry_dockerconfig contains the AWS Secrets Manager secret name that contains the Docker config authentication to the OCI registry hosting the Tanzu Application Platform images created earlier.

  5. Replace any TO DO sections from line 10 in the earlier example with the relevant values.

    Configuration example for SSH authentication:

    ---
secrets:
 eso:
  aws:
    region: us-west-2
    tanzu_sync_secrets:
      role_arn: arn:aws:iam::665100000000:role/iterate-green--tanzu-sync-secrets
  remote_refs:
    sync_git:
      ssh:
        private_key:
          key: dev/iterate-green/tanzu-sync/sync-git/ssh
          property: privatekey
        known_hosts:
          key: dev/iterate-green/tanzu-sync/sync-git/ssh
          property: knownhosts
    install_registry_dockerconfig:
      dockerconfigjson:
        key: dev/iterate-green/tanzu-sync/install-registry-dockerconfig

    Configuration example for basic authentication:

    ---
secrets:
 eso:
  aws:
    region: us-west-2
    tanzu_sync_secrets:
      role_arn: arn:aws:iam::665100000000:role/iterate-green--tanzu-sync-secrets
  remote_refs:
    sync_git:
      basic_auth:
        username:
          key: dev/iterate-green/tanzu-sync/sync-git/basic_auth
          property: username
        password:
          key: dev/iterate-green/tanzu-sync/sync-git/basic_auth
          property: password
    install_registry_dockerconfig:
      dockerconfigjson:
        key: dev/iterate-green/tanzu-sync/install-registry-dockerconfig

  6. Commit the Tanzu Sync configuration.

    For example, for the "iterate-green" cluster, run:

    git add tanzu-sync/
git commit -m 'Configure Tanzu Sync on "iterate-green"'

Review and store the Tanzu Application Platform installation config

Configuration for the Tanzu Application Platform installation is stored in two places:

  • Sensitive configuration is stored in AWS Secrets Manager.
  • Non-sensitive configuration is stored in YAML files in the Git repository.

Follow these steps to create the sensitive configuration and review the non-sensitive configuration:

  1. Create a secret named dev/${CLUSTER_NAME}/tap/sensitive-values.yaml that stores the sensitive data such as username, password, private key from the tap-values.yaml file:

    aws secretsmanager create-secret \
   --name dev/${CLUSTER_NAME}/tap/sensitive-values.yaml \
   --secret-string "$(cat <<EOF
---
# this document is intentionally initially blank.
EOF
)"

    You can start with an empty document and edit it later on as described in the Configure and push the Tanzu Application Platform values section.

  2. Review the integration with External Secrets Operator.

    This configuration was generated by the configure.sh script. It reported:

    ...
wrote AWS Secrets Manager configuration for TAP Install to: cluster-config/values/tap-install-aws-secrets-manager-values.yaml
...

    For example, for the iterate-green cluster, if the AWS account is 665100000000, tap-install-aws-secrets-manager-values.yaml contains the following information:

    ---
tap_install:
 secrets:
   eso:
     aws:
       region: us-west-2
       tap_install_secrets:
         role_arn: arn:aws:iam:665100000000:iterate-green--tap-install-secrets
     remote_refs:
       tap_sensitive_values:
         sensitive_tap_values_yaml:
           key: dev/iterate-green/tap/sensitive-values.yaml

    Where:

    • role_arn is the IAM role that grants permission to the Tanzu Application Platform installation to read its associated secrets. This role was created in the Grant read access to secret data section.
    • sensitive_tap_values_yaml.key is the AWS Secrets Manager secret name that contains the sensitive data from the tap-values.yaml file for this cluster in a YAML format.

  3. (Optional) Update Tanzu Application Platform to use the latest patch:

    Update the Tanzu Application Platform version in GIT-REPO-ROOT/clusters/CLUSTER-NAME/cluster-config/values/tap-install-values.yaml:

    tap_install:
    ...
    version:
        package_repo_bundle_tag: "{{ vars.tap_version }}" # Populate these values with the latest patch version.
        package_version: "{{ vars.tap_version }}"

    Where:

    • package_repo_bundle_tag is the version of Tanzu Application Platform you want to upgrade to.
    • package_version is the version of Tanzu Application Platform you want to upgrade to. This version must match package_repo_bundle_tag.

    Note Tanzu GitOps RI does not provide a separate artifact for each patch version within a minor line. For example, Tanzu Application Platform v1.6.x only contains the v1.6.1 GitOps artifact.

  4. Commit the Tanzu Application Platform installation configuration.

    For example, for the iterate-green cluster, run:

    git add cluster-config/
git commit -m 'Configure installer for TAP 1.6.1 on "iterate-green"'

Configure and push the Tanzu Application Platform values

The configuration for the Tanzu Application Platform is divided into two separate locations:

Follow these steps to split the Tanzu Application Platform values:

  1. Create the cluster-config/values/tap-values.yaml file by using the Full Profile (AWS), which contains the minimum configurations required to deploy Tanzu Application Platform on AWS.

    The Tanzu Application Platform values are input configurations to the Tanzu Application Platform installation and are placed under the tap_install.values path.

    tap_install:
  values:
    # Tanzu Application Platform values go here.
    shared:
      ingress_domain: "INGRESS-DOMAIN"
    ceip_policy_disclosed: true
...

    To install Tanzu Application Platform in an offline environment, you must configure Tanzu Build Service and Grype to work in an air-gapped environment:

    ---
tap_install:
  values:
    ...
    buildservice:
      exclude_dependencies: true
    grype:
      db:
        dbUpdateUrl: INTERNAL-VULN-DB-URL

    Where INTERNAL-VULN-DB-URL is the URL that points to the internal file server.

    For more information, see Components and installation profiles.

  2. Review the contents of tap-values.yaml and move all the sensitive values into the AWS Secrets Store secret created in the Review and store Tanzu Application Platform installation config section.

    For example, if the iterate-green cluster is configured with the basic Out of the Box Supply Chain, this might include a passphrase for that supply chain's GitOps flow:

    ---
tap_install:
 values:
   ...
   ootb_supply_chain_basic:
     registry:
       server: "SERVER-NAME"
       repository: "REPO-NAME"
     gitops:
       ssh_secret: "SSH-SECRET-KEY"   # Sensitive value. Do not commit to the Git repository.
   ...

    To maintain the secrecy of ootb_supply_chain_basic.gitops.ssh_secret, move this value from the tap-values.yaml file:

    ---
tap_install:
 values:
   ...
   ootb_supply_chain_basic:
     registry:
       server: "SERVER-NAME"
       repository: "REPO-NAME"
   ...

    Add it to the AWS Secrets Store secret named dev/iterate-green/tap/sensitive-values.yaml, by default, without the tap_install.values root:

    ---
...
ootb_supply_chain_basic:
 gitops:
   ssh_secret: "SSH-SECRET-KEY"
...

    To update the secret value, follow the instructions in Modify an AWS Secrets Manager secret.

    When moving values, you must omit the tap_install.values root, but keep the remaining structure. All of the parent keys, such as ootb_supply_chain_basic.gitops and ssh_secret, must be copied to the sensitive value YAML.

  3. Commit and push the Tanzu Application Platform values:

    git add cluster-config/
git commit -m "Configure initial values for TAP 1.6.1"
git push

    Tanzu Sync fetches configuration from the hosted clone of the Git repository. For changes to take effect on the cluster, they must be pushed to that clone of the Git repository.

Deploy Tanzu Sync

Deploying Tanzu Sync starts the GitOps workflow that initiates the Tanzu Application Platform installation.

After deployed, Tanzu Sync periodically polls the Git repository for changes. The following deployment process is only required once per cluster:

  1. Install the Carvel tools kapp and ytt onto your $PATH:

    sudo cp $HOME/tanzu-cluster-essentials/kapp /usr/local/bin/kapp
sudo cp $HOME/tanzu-cluster-essentials/ytt /usr/local/bin/ytt

    This step is required to ensure the successful deployment of the tanzu-sync app.

  2. Ensure the Kubernetes cluster context is set to the EKS cluster.

    1. List the existing contexts:

      kubectl config get-contexts

    2. Set the context to the cluster that you want to deploy:

      kubectl config use-context CONTEXT-NAME

      Where CONTEXT-NAME can be retrieved from the outputs of the previous step.

  3. Bootstrap the deployment.

    External Secrets Operator is installed from the package included in the Tanzu Application Platform package repository. That repository must be fetched from the OCI registry initially.

    1. Set the following environment variables:

      export INSTALL_REGISTRY_HOSTNAME=MY-REGISTRY
export INSTALL_REGISTRY_USERNAME=MY-REGISTRY-USER
export INSTALL_REGISTRY_PASSWORD=MY-REGISTRY-PASSWORD

      Where:

      • MY-REGISTRY is your container registry.
      • MY-REGISTRY-USER is the user with read access to MY-REGISTRY.
      • MY-REGISTRY-PASSWORD is the password for MY-REGISTRY-USER.

    2. Create a secret containing credentials to fetch from that OCI registry by using the provided script:

      tanzu-sync/scripts/bootstrap.sh

      These credentials are used exactly once to install the External Secrets Operator (ESO) package.

  4. Install Tanzu Sync and start the GitOps workflow by deploying it to the cluster using kapp and ytt.

    tanzu-sync/scripts/deploy.sh

    Depending on the profile and components included, it may take 5-10 minutes for the Tanzu Application Platform to install. During this time, kapp waits for the deployment of Tanzu Sync to reconcile successfully. This is normal.

    You can track the progress of the installation by watching the installation of those packages in a separate terminal window:

    watch kubectl get pkgi -n tap-install

{{#unless vars.hide_content}}

{{/unless}}