Integrate Edge with a Google Secret Manager Vault

You can integrate your Edge site with your existing Google Secret Manager Vault to more easily and securely manage your data source information and set up your Edge site connections. In this topic, we review how to set up the integration between your Edge site and your existing vault.

Note There are a few limitations with the Google Secret Manager integration:

Use the steps below based on your vault authentication method for Edge sites installed on bunlded k3s.

You can integrate your Edge site with your Google Secret Manager using one of the following authentication methods:

IAM Role assigned to the Google Cloud Engine VM authentication

Prerequisites

On your local server

In your Collibra environment

In your vault platform

Steps

  1. In the cluster where your Edge site is installed, use the Edge CLI tool to run the command for the IAM role assigned to the Google Cloud Engine VM authentication method.
    Copy
    sudo ./edgecli vault create gcp iam-role <name> \
      --desc=<description> \
      --projectId=<projectId>
    Copy
    ./edgecli vault create gcp iam-role <name> \
      --desc=<description> \
      --projectId=<projectId>
    CommandDescription
    <name> (required)The name of the vault instance. It is required and it must be unique within an Edge site. For Kubernetes guidelines on the required naming conventions of the <name> parameter, go to Labels and Selectors.
    Note The name can only contain alphanumeric, dash (-), underscore ( _ ), or period (.) characters. The name cannot include white spaces or special characters such as /, !, ?.
    <description> (optional)The description of the vault instance. The maximum character length is 150.
    <projectId> (required)The ID of the Google Account project which contains the Google Secret Manager.
  2. Go to your Edge site to confirm the new vault is available in the Vaults tab.

Service Account JSON Key authentication

Prerequisites

On your local server

In your Collibra environment

In your vault platform

Steps

  1. In the cluster where your Edge site is installed, use the Edge CLI tool to run the command for the JSON key authentication method.
    Copy
    sudo ./edgecli vault create gcp sa-json <name> \
      --desc=<description> \
      --projectId=<projectId> \
      --keyPath=<keyPath>
    Copy
    ./edgecli vault create gcp sa-json <name> \
      --desc=<description> \
      --projectId=<projectId> \
      --keyPath=<keyPath>
    CommandDescription
    <name> (required)The name of the vault instance. It is required and it must be unique within an Edge site. For Kubernetes guidelines on the required naming conventions of the <name> parameter, go to Labels and Selectors.
    Note The name can only contain alphanumeric, dash (-), underscore ( _ ), or period (.) characters. The name cannot include white spaces or special characters such as /, !, ?.
    <description> (optional)The description of the vault instance. The maximum character length is 150.
    <projectId> (required)The ID of the Google Account project which contains the Google Secret Manager.
    <keyPath> (required)The file containing the Client Private Key.
  2. Go to your Edge site to confirm the new vault is available in the Vaults tab.

Service Account P12 Key authentication

Prerequisites

On your local server

In your Collibra environment

In your vault platform

Steps

  1. In the cluster where your Edge site is installed, use the Edge CLI tool to run the command for the P12 key authentication method.
    Copy
    sudo ./edgecli vault create gcp sa-p12 <name> \
      --desc=<description> \
      --projectId=<projectId> \
      --keyPath=<keyPath> \
      --keyPassword=<keyPassword> \
      --emailAddress=<emailAddress>
    Copy
    ./edgecli vault create gcp sa-p12 <name> \
      --desc=<description> \
      --projectId=<projectId> \
      --keyPath=<keyPath> \
      --keyPassword=<keyPassword> \
      --emailAddress=<emailAddress>
    CommandDescription
    <name> (required)The name of the vault instance. It is required and it must be unique within an Edge site. For Kubernetes guidelines on the required naming conventions of the <name> parameter, go to Labels and Selectors.
    Note The name can only contain alphanumeric, dash (-), underscore ( _ ), or period (.) characters. The name cannot include white spaces or special characters such as /, !, ?.
    <description> (optional)The description of the vault instance. The maximum character length is 150.
    <projectId> (required)The ID of the Google Account project which contains the Google Secret Manager.
    <keyPath> (required)The file containing the Client Private Key.
    <keyPassword>The P12 password.
    <emailAddress>The Google Service Account email address.
  2. Go to your Edge site to confirm the new vault is available in the Vaults tab.

What's next