Skip to content

Setup

What Will You Do

In this part, you will use the Platform Team persona (i.e. Infra Admin role in Rafay) to import and configure the environment template for the PhoenixNAP infrastructure.

Important

This is a one-time setup. Once completed, it can be shared/used by 100s/1000s of developers in your Org.

Step 1: Import Template

In this step, you will use the Loader Utility to import the Environment Manager templates needed for this environment.

  • Follow the instructions here to use the loader utility
  • When using the loader utility, be sure to uncomment the following template - ../terraform/mks/101-caas-pnap in the templates section of the values.yaml file

Once Complete, you will see the new environment card in your organization under Environments -> Environments

Step 2: Configure Environment Contexts

In this step, you will configure the environment contexts in the controller with your PhoenixNAP and Rafay account details. These account details will be used by Environment Manager to interact with your accounts.

Configure PhoenixNAP Context

You will use the API configuration details of your PhoenixNAP account to populate this config context. The values needed can be found in a in your PhoenixNAP account under Access -> API Credentials

  • Log into the controller and select your project
  • Navigate to Environments -> Config Contexts
  • Click on the existing phoenixnap config context name
  • Select Environment Variables
  • Populate the API client ID and secret values for your PhoenixNAP account
  • Ensure that you select the sensitive checkbox for both fields
  • Click Save

Populate Context

Important

The Rafay agent automatically writes back the environment variables to Git. The resources (esp. secrets) you identify as sensitive. will be automatically encrypted using a secret sealer before being synced to your Git repo.

Configure Rafay Context

You will use the CLI configuration details of your Rafay account to populate this config context. The values needed can be found in a CLI config file. To obtain a CLI config file, navigate to Home -> My Tools -> Download CLI Config

  • Navigate to Environments -> Config Contexts
  • Click on the existing Rafay config context name
  • Select Environment Variables
  • Populate the API key, secret and endpoint variables (Note: the project variable is pre-populated for you)
  • Ensure that you select the sensitive checkbox for both fields

Populate Context

  • Select File Paths
  • Click Upload File
  • Select the Private SSH key for your PhoenixNAP servers (Note, this setting is configured in your PhoenixNAP account under Access -> SSH Keys Management )
  • Ensure that you select the sensitive checkbox
  • Click Save

Populate Context

Important

The Rafay agent automatically writes back the environment variables to Git. The resources (esp. secrets) you identify as sensitive. will be automatically encrypted using a secret sealer before being synced to your Git repo.

Step 3: Configure Template Variables

In this step, you will review the resource templates and environment templates to ensure that all variables are updated for your environment.

  • Navigate to Environments -> Resource Templates
  • Click on the resource templates that were created
  • Click the view icon of the template version
  • Verify all Input Variables

If any Input variables need to be modified, create a new version of the template with the modified variables. If a new version is created, be sure to update the Environment Template with any updated resource template versions.

  • Navigate to Environments -> Environment Templates
  • Click on the environment template that was created
  • Click the view icon of the template version
  • Verify all Input Variables

If any input variables need to be modified, create a new version of the template with the modified variables.

Recap

At this point, you have everything setup and configured to manage the infrastructure environment through Environment Manager.