Creating and editing environment key value maps

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

This topic shows you how to create and edit key value maps (KVMs) in the UI. The KVMs you create in the UI are environment scoped. For more information about KVMs and scope, see Working with key value maps.

Enabling encrypted KVMs in the Edge UI with Edge for Private Cloud

Encrypted KVMs are supported in Edge for Private Cloud version 4.17.01 and later. However, support for encrypted KVMs in the Edge UI is disabled by default. To enable the Edge UI to support encrypted KVMs:

  1. On the Edge UI server, open the ui.properties file in an editor. If the file does not exist, create it:
    > vi /opt/apigee/customer/application/ui.properties
  2. Set the conf_apigee_apigee.feature.kvmencryption token to true:
    conf_apigee_apigee.feature.kvmencryption=true
  3. Save your changes.
  4. Change the owner of ui.properties to "apigee":
    > chown apigee:apigee /opt/apigee/customer/application/ui.properties
  5. Restart the Edge UI:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-ui restart

Managing your environment key value maps

Manage your KVMs, as described below. KVMs are defined at the environment scope. For example, if you create a KVM in the 'test' environment, API proxies running in the 'prod' environment won't have access to the KVM.

Edge

To manage KVMs using the Edge UI:

  1. Sign in to apigee.com/edge.
  2. Select Admin > Environments > Key Value Maps in the left navigation bar.
  3. To create a KVM:
    1. Click + Key value map.
    2. Enter property values for the new KVM. The following table describes the settings.
      Property Name Description
      Name Name of the KVM. Must be unique in the environment. Reference this name from policies that interact with the KVM.
      EncryptedFlag that specifies whether the KVM is encrypted. In the UI, encrypted values will appear as asterisks (*****). Encryption is set on the entire map. You cannot set encryption entry by entry.
      Note: You can only encrypt KVMs when you create them. You can't encrypt or decrypt a key value map after it's been created.
    3. Click Add.
  4. To add an entry to a KVM:
    1. Click the name of the KMV in the list to display the current entries.
    2. Click +.
    3. Enter property values for the new KVM entry, as described below.
      Property Name Description
      Key

      Key name that you'll use to access the data value in your API proxies.

      With Apigee Edge for Public Cloud, key names cannot be larger than 2 KB.

      In the Edge UI, names cannot contain "/".
      Value

      Value of the key. Enter any combination of numbers, letters, or special characters.

      Note: The total size of a KVM cannot be larger than 15 MB.
    4. Click Add.
  5. To manage the key entries in a KVM:
    1. Click the name of the KVM in the list to display the current entries.
    2. Position your cursor over the KVM entry to display the actions menu and perform one of the following tasks:
      • To copy the value of an entry, click .
      • To edit an entry, click . Then, edit the entry and click Update.
      • To delete an entry, click . Then, click Delete to confirm the operation.

Classic Edge (Private Cloud)

To create and edit KVMs using the Classic Edge UI:

  1. Sign in to http://ms-ip:9000, where ms-ip is the IP address or DNS name of the Management Server node.
  2. Select APIs > Environment Configuration > Key Value Maps.
  3. Select the environment for which you want to configure caches, such as test or prod.
  4. To create a KVM:
    1. Click + Key Value Map.
    2. Enter property values for the new KVM, as described below.
      Property Name Description
      Name Name of the KVM. Must be unique in the environment. Reference this name from policies that interact with the KVM.
      EncryptedFlag that specifies whether the KVM is encrypted. In the UI, encrypted values will appear as asterisks (*****). Encryption is set on the entire map. You cannot set encryption entry by entry.
      Note: You can only encrypt KVMs when you create them. You can't encrypt or decrypt a key value map after it's been created.
    3. Click Add.
  5. To add an entry to a KVM:
    1. Click the name of the KVM in the list to expand its list of entries.
    2. Click + Entry
    3. Enter property values for the new KVM entry, as described below.
      Property Name Description
      Key

      Key name that you'll use to access the data value in your API proxies. In the Edge UI, names cannot contain "/".

      Note: With Edge for Public Cloud, key names cannot be larger than 2 KB.
      Value

      Value of the key. Enter any combination of numbers, letters, or special characters.

      Note: The total size of a KVM cannot be larger than 15 MB.
    4. Click Save.
  6. To edit or delete the key entries in a KVM:
    1. Click the name of the KVM in the list to expand its list of key entries.
    2. Perform one of the following actions:
      • To edit an entry, click Edit, edit the entry, and click Save.
      • To delete an entry, click Delete.