Skip to main content

Install with the agent wizard

You can use the Agent Wizard to install the Kubernetes Operator using Helm or a single-file installation YAML manifest that can be directly applied to a cluster. Helm is the recommended method of installation.

Before you begin

Make sure you have everything you need before you start:

  • The agent will need to be able to reach your Contrast instance. It can be a local/on-premise instance or a hosted instance. A proxy can be configured if the environment has limited network access.

  • It must use supported technologies and networking requirements.

  • Understand the order of precedence.

  • The agent will need to be able to reach your Contrast instance. It can be a local/on-premise instance or a hosted instance. A proxy can be configured if the environment has limited network access.

Start the Kubernetes agent wizard

  1. Under Select an installation method, select Multi-language via Kubernetes.

  2. Open the agent wizard:

    • Northstar: From the left navigation, select Administration > Agent management. Then, select Add agent at the top of the view.

    • Contrast: Use either of these options:

      • From the header, select Add New and then, select the Application card.

      • Select Administration > Agent management. Then, select Add agent at the top of the view.

Kubernetes: (Linux only)

  1. Under Select method to configure agent operator, select Helm (recommended) or Manifest.

  2. For Helm:

    1. Under Download and set up files, copy the displayed commands to create a values file. Skip this step if the operator is already installed.

    2. Under Install and deploy Helm chart, copy the displayed commands to complete the configuration. Skip this step if the operator is already installed.

    3. Label your namespaces to add AgentInjectors.

      kubectl label namespace/<YourNamespaceName> agents.contrastsecurity.com/agent-injectors=true
    4. Under Label the deployments, use the displayed commands to label your deployments.

  3. For Manifest:

    1. Under Install operator, copy the displayed commands to install the Contrast agent operator.

    2. Under Configure operator, copy the displayed commands to configure the Contrast agent operator.

    3. Under Configure injector, copy or download the clusterAgentInjector.yaml

    4. Label your namespaces to add AgentInjectors.

      kubectl label namespace/<YourNamespaceName> agents.contrastsecurity.com/agent-injectors=true
    5. Under Label the deployments, use the displayed commands to label your deployments.

    6. Optionally, under Configure cluster agent and cluster, copy the displayed commands to configure these entities.

Verify the agent deployment

  1. Interact with your application as you normally would. For example, interact with your application's web interface or send API commands.

  2. Select Administration, then Agent management to verify that your agent appears in the list.

  3. Verify that you see the name of your application in the list.

  4. Select Servers in the header.

  5. Verify that you see the name of your local server in the list.