Skip to main content
Feedback

Creating Other Secrets

V3 API secret (in v6.0.0 and v6.1.0)

Definition in LE v6.0.0Definition in LE v6.1.0

These values are available in the customized json properties from step 1 in Preparing a Database.

The JSON attributes are your_api_key_for_v3_api and your_secret_for_v3_api .

Sample secret files are available in: sample/configui/configui-secrets-with-encryption.yaml and samples/configui/configui-secrets.yaml

This is the key and secret pair that ConfigUI uses to call the V3 API or CAM Platform API. The key and secret are generated using the customization script.

Refer to Customizing IDs and Keys for Local Edition for more information.

You can find sample of Other secrets files under this path: samples/general.

API Debug Key Secret (introduced in v6.1.0)

tip

This section was added in the Boomi Cloud API Management – Local Edition 6.1.0 release.

  • You can find api-debug-header-secrets samples under the following path: samples/general/api-debug-header-secrets-sample.yaml

  • Do not change the secret name and attribute name.

  • .apiDebugKey - This should be exactly 24 characters. We recommend you to use randomized text.

  • .apiDebugSecret - This should be exactly 10 characters. We recommend you to use randomized text.

Creating ConfigUI Secret

With Encryption

Procedure

  1. Encrypt API key.

    $ mkdir -p <extract location/certs/configui>
    $ cd <extract location>/certs/configui
    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t '<value of your_api_key_for_v3_api from customised papi json>'

  2. Encrypt API secret.

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t '<value of your_secret_for_
    v3_api from customised papi json>'

  3. Base64 encode the secret and nonce.

    $ echo -n 'abcd1234efgh5678' | base64
    YWJjZDEyMzRlZmdoNTY3OA==

    $ echo -n '1234abcd5678efgh' | base64
    MTIzNGFiY2Q1Njc4ZWZnaA==

  4. Create the YAML file for creating Kubernetes secret. Do not change the secret name and the attribute name.

    xml
    apiVersion: v1
    kind: Secret
    metadata:
    name: configui-secrets
    data:
    .mlc_apikey: <output of step 1>
    .mlc_apisecret: <output of step 2>
    .mlc_aeadsecret: YWJjZDEyMzRlZmdoNTY3OA==
    .mlc_aeadnonce: MTIzNGFiY2Q1Njc4ZWZnaA==

  5. Apply the secret manifest to create the Kubernetes secret in your cluster.

    $ kubectl apply -f configui-secrets-with-encryption.yaml
    info

    This section was added in the Boomi Cloud API Management – Local Edition 6.1.0 release.

    You can find the samples of ConfigUI secrets at samples/configui/configui-secrets.yaml. Do not change the secret name and attribute name.

    KeyValueNotes
    .mlc_apikeyThis is generated by running customize.sh.The API key is used by ConfigUI to authenticate against the Platform API.
    .mlc_apisecretThis is generated by running customize.sh.The API secret is used by ConfigUI to authenticate against the Platform API.

    For encrypting ConfigUI secrets, use apim_cyrpto. You can find a sample of an encrypted ConfigUI secrets at this path: samples/configui/configui-secrets-with-encryption.yaml

Without Encryption

Procedure

  1. Base64 encode API Key and API secret.

    $ echo -n '<value of your_api_key_for_v3_api from customised papi json>' | base64
    Sample ouput : YWJjZDEyMzRlZmdoNTY3OA==

    $ echo -n '<value of your_secret_for_v3_api from customised papi json>' | base64
    Sample output : MTIzNGFiY2Q1Njc4ZWZnaA==

  2. Create a YAML file for creating the Kubernetes secret. Do not change the secret name and the attribute name.

    apiVersion: v1
    kind: Secret
    metadata:
    name: configui-secrets
    data:
    .mlc_apikey: <output from step 1>
    .mlc_apisecret: <output from step 2>

  3. Apply the secret manifest to create the Kubernetes secret in your cluster.

    $ kubectl apply -f configui-secrets.yaml

Creating ConfigUI User Secret

With Encryption

You can find the samples of ConfigUI User secrets at samples/configui/configui-usersecrets.yaml.

note
  • You must modify the secret.
  • Do not change the secret name and attribute name.
KeyValueNotes
.mlc_passwordConfigUI admin user passwordYou must set the ConfigUI admin password.
.mlc_server_secret32 char textProvide the server key for encryption. We recommend using random characters.

For encrypting ConfigUI User secrets, use apim_cyrpto. You can find the sample of an encrypted ConfigUI secrets at samples/configui/configui-usersecrets-with-encryption.yaml

Procedure

  1. Apply the secret manifest to create the Kubernetes secret in your cluster.

    $ kubectl apply -f samples/configui/configui-secrets.yaml
    $ kubectl apply -f samples/configui/configui-usersecrets.yaml

  2. Optional: Use the encrypted version.

    $ kubectl apply -f samples/configui/configui-secrets-with-encryption.yaml

Creating Mashery Onprem Manager (MOM) API Key and Secret (introduced in v6.1.0)

tip

This section was added in the Boomi Cloud API Management – Local Edition 6.1.0 release.

With Encryption

You can use mom-secret-encrypted.yaml or mom-secret-sample.yaml secret templates in the samples/general/ folder.

note

You should change the mom-secret-encrypted.yaml or mom-secret-sample.yaml secret template only when you deploy the Tethered cluster. Additionally, the parameters in the mom-secret-encrypted.yaml file have shifted to the mom-secret-sample.yaml file, and vice-versa.

When encrypting apikey and secret, use the same salt and nonce. The output of the encryption utility is Base64 encoded and can be used directly.

Procedure

  1. Encrypt API key and secret.

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <apikey>
    Sample output: 
    YzQ4YTU4YTM2YzQ4YTU4YTM2...AQEA=

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <secret>
    Sample output: 
    ZmEwMjhmMDMy...QA==

  2. Base64 encode salt and nonce.

    $ echo -n 'abcd1234efgh5678' | base64
    YWJjZDEyMzRlZmdoNTY3OA==

    $ echo -n '1234abcd5678efgh' | base64
    MTIzNGFiY2Q1Njc4ZWZnaA==

  3. Create the YAML file to create a Kubernetes secret. Do not change the secret name and attribute name.

    apiVersion: v1

       kind: Secret
       metadata:
          name: mom-secret
       data:
          .apimmomkey: N2UzM3U0Y.......JnYnkzN201dWZ2
          .apimmomsecret: ZXFzc.....hZNw==
          .momaeadsecret: YWJjZDEyMzRlZmdoNTY3OA==
          .momaeadnonce: MTIzNGFiY2Q1Njc4ZWZnaAo=

Without Encryption

You can use secret templates in samples/general/.

Procedure

  1. Base64 encode apikey and apisecret.

    $ echo -n <MOM apikey> | base64
    Sample output : cnpwaHZxOTg0Nnkza3FxOGgzcDVmd2dnCh==

    $ echo -n <MOM apisecret> | base64
    Sample output: cktaSEM6RlFqbio=

  2. Create a YAML file to create a secret. Do not change the secret name and attribute name.

    apiVersion: v1
    kind: Secret
    metadata:
     name: mom-secret
    data:
        # $ echo <apikey> | base64
       .apimmomkey: N2UzM3U0Y.......JnYnkzN201dWZ2
     # $ echo <apisecret> | base64
    .apimmomsecret: ZXFzc.....hZNw==

Creating an Area Encryption Key in Local Edition (introduced in v6.3.0)

tip

This section was added in the Boomi Cloud API Management – Local Edition 6.3.0 release.

Before you begin, ensure you have the decrypted encoded area encryption key from the Cloud API Management (SaaS) Area information pop-up window. To view the area encryption key, refer to Area Encryption Key.

With Encryption

You can use area-key-secret-with-encryption.yaml
key and secret templates in the /samples/trafficmanager folder.

When encrypting area_key, use the same salt and nonce. The output of the encryption utility is base64 encoded and can be used directly.

Procedure

  1. Base64 encode the area encryption key.

    $ echo -n '<area_key>' | base64
    uX...osI=

  2. Base64 encode the cryptography salt and nonce.

    $ echo -n '<areaKey_aeadsecret>' | base64
    VHl...odA==

    $ echo -n '<areaKey_aeadnonce>' | base64
    SW...odA==

  3. Create the YAML file to create a secret. Do not change the secret name and attribute name.

    % cat ../samples/trafficmanager/area-key-secret-with-encryption.yaml
    apiVersion: v1
    kind: Secret
    metadata:
       name: area-key-secrets
    data:
       .areaKey: uX...osI=
       .areaKey_aeadsecret: VHl...odA==
       .areaKey_aeadnonce: SW...odA==

  4. Apply the secret manifest to create the Kubernetes secret in your cluster.

    With encryption
    kubectl apply -f area-key-secret-with-encryption.yaml

Without Encryption

You can use secret templates in samples/trafficmanager/.

Procedure

  1. Base64 encode the area encryption key.

    $ echo -n '<value of your_encoded_decrypted_area_key>' | base64
    Sample ouput : SUh...ND0=

  2. Create a YAML file to create a secret.

    % cat ../samples/trafficmanager/area-key-secret.yaml
    apiVersion: v1
    kind: Secret
    metadata:
       name: area-key-secrets
    data:
       .areaKey: SUh...ND0=

  3. Apply the secret manifest to create the Kubernetes secret in your cluster.

    Without encryption
    kubectl apply -f area-key-secret.yaml

Creating and applying an SMTP secret

tip

This section was added in the Boomi Cloud API Management – Local Edition 6.3.0 release.

With Encryption

Sample encrypted SMTP Secret manifests are available in samples/general.

Procedure

  1. Base64 encode the SMTP username and password.

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <smtp username>
    Sample output:
    YzQ4YTU4YTM2...AQEA=

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <smtp password>
    Sample output:
    ZmEwMjhmMDMy...QA==

  2. Base64 encode the cryptography salt and nonce.

    $ echo -n abcd1234efgh5678 | base64 
    YWJjZDEyMzRlZmdoNTY3OA==

    $ echo -n 1234abcd5678efgh | base64 
    MTIzNGFiY2Q1Njc4ZWZnaA==

  3. Create a Kubernetes Secret using the encrypted credentials, encoded salt, and nonce. Do not modify the Secret name or key names. Replace the sample values with your own.

    apiVersion: v1
       kind: Secret
       metadata:
       name: apim-smtp-secret
       type: Opaque
       data:
       .apimsmtpuser: YXBwbGljYXRpb24ub3duZXJAZXhhbXBsZS5jb20=
       .apimsmtppasswd: PHlvdXJfc210cF9wYXNzd29yZD4=
       .aeadsecret: YWJjZDEyMzRlZmdoNTY3OA==
       .aeadnonce: MTIzNGFiY2Q1Njc4ZWZnaAo=

  4. Apply the secret manifest to create the Kubernetes secret in your cluster.

    kubectl apply -f samples/general/smtp-secret-with-encryption-sample.yaml

Without Encryption

Sample SMTP Secret manifests are available in samples/general.

Procedure

  1. Base64 encode the SMTP username and password.

    $ echo -n <smtp user> | base64
    Sample output: cnpwaHZxOTg0Nnkza3FxOGgzcDVmd2dnCh==

    $ echo -n <smtp password> | base64
    Sample output: cktaSEM6RlFqbio=

  2. Create a YAML file to create a secret. Replace the sample encoded values below with your own base64-encoded credentials from the previous step 1.

    apiVersion: v1
    kind: Secret
    metadata:
       name: apim-smtp-secret
    type: Opaque
    data:
       .apimsmtpuser: <base64-encoded SMTP username>
       .apimsmtppasswd: <base64-encoded SMTP password>

  3. Apply the secret manifest to create the Kubernetes secret in your cluster.

    kubectl apply -f samples/general/smtp-secret-sample.yaml

Creating HTTP Proxy Secrets (introduced in v6.2.0)

tip

This section was added in the Boomi Cloud API Management – Local Edition (LE) 6.2.0 release.

With Encryption

You can use http-proxy-secret-with-encryption.yaml or its sample template in the samples/general/ folder.

note

You should change the http-proxy-secret-with-encryption.yaml template only when you deploy the Tethered cluster.

When encrypting the proxy username and password, use the same salt and nonce. The output of the encryption utility is base64 encoded and can be used directly.

Procedure

  1. Encrypt proxy username and password.

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <proxy-username>
    Sample output: YzQ4YTU4YTM2...MzQzMzMyMzg2NS1AQEA=

    $ apim_crypto -s 'abcd1234efgh5678' -n '1234abcd5678efgh' -t <proxy-password>
    Sample output: ZmEwMjhmMDMy...MzUzNTY1LUBAQA==

  2. Base64 encode cryptography salt and nonce.

    $ echo -n 'abcd1234efgh5678' | base64
    YWJjZDEyMzRlZmdoNTY3OA==

    $ echo -n '1234abcd5678efgh' | base64
    MTIzNGFiY2Q1Njc4ZWZnaA==

  3. Create the YAML file to create a Kubernetes secret.

    note

    Do not change the secret name and attribute name.

    yaml
    apiVersion: v1
    kind: Secret
    metadata:
    name: http-proxy-secret-with-encryption
    data:
    .proxyuser: YzQ4YTU4YTM2...MzQzMzMyMzg2NS1AQEA=
    .proxypassword: ZmEwMjhmMDMy...MzUzNTY1LUBAQA==
    .proxyaeadsecret: YWJjZDEyMzRlZmdoNTY3OA==
    .proxyaeadnonce: MTIzNGFiY2Q1Njc4ZWZnaA==

Without Encryption

You can use http-proxy-secret.yaml or its sample template in the samples/general/ folder.

  1. Base64 encode proxy username and password.

    $ echo -n "<proxy-username>" | base64
    Sample output: Y3JwYnh1c2VyCg==

    $ echo -n "<proxy-password>" | base64
    Sample output: cHJveHlQYXNzCg==

  2. Create the YAML file to create a secret.

    note

    Do not change the secret name and attribute name.

    yaml
    apiVersion: v1
    kind: Secret
    metadata:
    name: http-proxy-secret
    data:
    .proxyuser: Y3JwYnh1c2VyCg==
    .proxypassword: cHJveHlQYXNzCg==

Creating General Secret

Apply the secret manifest to create the Kubernetes secret in your cluster.

$ kubectl apply -f samples/general/api-debug-header-secrets-sample.yaml

important

  • In LE v6.0.0, the secret must not be modified.

  • In LE v6.1.0, you must modify the secret as part of the setup.

Creating General Proxy Secret (introduced in v6.2.0)

tip

This section was added in the Boomi Cloud API Management – Local Edition (LE) 6.2.0 release.

Apply the secret manifest to create the Kubernetes secret in your cluster.

$ kubectl apply -f samples/general/http-proxy-secret-sample.yaml

On this Page