Module reference secrets

Reference secrets should be used for protected properties in a module configuration file, such as a client secret or password, to securely transit them to the device. Protected properties, such as client secrets and passwords, should not be entered into the configuration file directly. See How to reference Secrets for more information on reference secrets.

Edge Management only supports the use of the following secretIds for reference secrets:

• Secret1

• Secret2

• Secret3

• Secret4

• Secret5

For example:

{

"id": "PI Web API",

"endpoint": "https://<pi web api server>:<port>/piwebapi/omf",

"username": "myusername",

"password": "{{Secret1}}"

}

In the Edge Management portal, use the Secret Store to enter the values of the protected properties for the corresponding secretIds. Next, the system provides a script to run directly on the device that sets the values of the reference secrets.

Important: If you are upgrading the AVEVA Adapter for OPC UA Edge Module from 1.3.1.6 to a newer version and your module configuration file previously used secrets with any of the following identifiers, the secret variables need to be changed to the supported secretIds above.

{{EgressEndpointSecret}}
{{AdditionalEgressEndpointSecret}}
{{DataSourceSecret}}
{{AdditionalDataSourceSecret}}