Standard configuration
The Moderne on-premise agent securely connects the Moderne SaaS to customers' environments. It's delivered as an OCI image and can be run using any OCI runtime (e.g., Docker, Podman).
The purpose of the Moderne on-premise agent is to encrypt and ship AST artifacts from artifact repositories (e.g., Artifactory) to the Moderne SaaS, provide the symmetric key to be used for decryption, and forward requests from the Moderne SaaS to your version control system (e.g., Github).

Run the agent container

The Moderne on-premise agent is available as an OCI image or as a spring-boot executable jar artifact. Contact Moderne to obtain access. Moderne will provide access details appropriate for your chosen platform. In example commands below we will refer to this as ${MODERNE_AGENT_IMAGE_NAME}. The latest one will be displayed in the "Agent" section of the releases page. Please note that additional integration-specific configuration is required, and consult the other subpages of On-premise agent.
OCI Container
Executable JAR
Authenticate:
docker login -u moderne-tenant -p <ACR password, provided by Moderne> moderne.azurecr.io
​
The agent container requires several environment variables:
  • MODERNE_AGENT_API_GATEWAY_RSOCKET_URI - URI used to connect to the Moderne API, provided by Moderne
  • MODERNE_AGENT_TOKEN - Moderne SaaS agent connection token, provided by Moderne
  • MODERNE_AGENT_CRYPTO_SYMMETRICKEY - 256 bit AES encryption key, hex encoded
    • example OpenSSL command to generate: openssl enc -aes-256-cbc -k secret -P (use key from the output)
Example using Docker (note that agent token and symmetric key are random examples)
docker run \
-e MODERNE_AGENT_NICKNAME=prod-1 \
-e MODERNE_AGENT_API_GATEWAY_RSOCKET_URI=https://api.tenant.moderne.io/rsocket \
-e MODERNE_AGENT_TOKEN=W43qp4h952T4w2qV \
-e MODERNE_AGENT_CRYPTO_SYMMETRICKEY=546A576E5A7234753778217A25432A462D4A614E645267556B58703273357638 \
${MODERNE_AGENT_IMAGE_NAME}
The agent application requires several arguments:
  • --moderne.agent.apiGatewayRsocketUri - URI used to connect to the Moderne API, provided by Moderne
  • --moderne.agent.token - Moderne SaaS agent connection token, provided by Moderne
  • --moderne.agent.crypto.symmetricKey - 256 bit AES encryption key, hex encoded
    • example openssl command to generate: openssl enc -aes-256-cbc -k secret -P (use key from the output)
Note: system properties can be used in place of arguments. As an example, use -Dmoderne.agent.token={token_value} as an argument instead of --moderne.agent.token={token_value} as an argument.
Example (note that agent token and symmetric key are random examples)
java -jar moderne-agent-{version}.jar \
--moderne.agent.nickname=prod-1 \
--moderne.agent.api-gateway-rsocket-uri==https://api.tenant.moderne.io/rsocket \
--moderne.agent.token=W43qp4h952T4w2qV \
--moderne.agent.crypto.symmetricKey=546A576E5A7234753778217A25432A462D4A614E645267556B58703273357638

Upgrading Agent Version

OCI Container
Executable JAR
To upgrade your version of the OCI container, just follow the instructions above, but change ${MODERNE_AGENT_IMAGE_NAME} to the latest release of Agent on the releases page.
To update your version of the Executable JAR, change the numbered version of {agent} in the instructions above to the latest on the releases page.