constellation/docs/versioned_docs/version-2.0/getting-started/install.md
2022-09-13 12:05:07 +02:00

4.3 KiB

Installation and Setup

Constellation runs entirely in your cloud environment and can be easily controlled via a dedicated Command Line Interface (CLI).

The following guides you through the steps of installing the CLI on your machine, verifying it, and connecting it to your Cloud Service Provider (CSP).

Prerequisites

Make sure the following requirements are met:

  • Your machine is running Linux or macOS
  • You have admin rights on your machine
  • kubectl is installed
  • Your cloud provider is Microsoft Azure or Google Cloud Platform (GCP)

Install the Constellation CLI

Download the CLI executable from the release page. Move the downloaded file to a directory in your PATH (default: /usr/local/bin) and make it executable by entering chmod u+x constellation in your terminal.

:::note Edgeless Systems uses sigstore to sign each release of the CLI. You may want to verify the signature before you use the CLI. :::

:::tip The CLI supports autocompletion for various shells. To set it up, run constellation completion and follow the given steps. :::

Set up cloud credentials

The CLI makes authenticated calls to the CSP API. Therefore, you need to set up Constellation with the credentials for your CSP. Currently, Microsoft Azure and Google Cloud Platform (GCP) are the only supported CSPs.

Step 1: Authenticate

First, you need to authenticate with your CSP. The following lists the required steps for testing and production environments.

:::danger The steps for a testing environment are simpler. However, they may expose secrets to the CSP. If in doubt, follow the production steps. :::

Testing

Simply open the Azure Cloud Shell.

Production

Use the latest version of the Azure CLI on a trusted machine:

az login

Other options are described in Azure's authentication guide.

Enable the following cloud APIs first:

Testing

If you are running from within VM on GCP, and the VM is allowed to access the necessary APIs, no further configuration is needed.

If you are using the Google Cloud Shell, make sure your session is authorized. For example, execute gsutil and accept the authorization prompt.

Production

For production, use one of the following options on a trusted machine:

  • Use the gcloud CLI

    gcloud auth application-default login
    

    This will ask you to log-in to your Google account and create your credentials. The Constellation CLI will automatically load these credentials when needed.

  • Set up a service account and pass the credentials manually

    Follow Google's guide for setting up your credentials.

Step 2: Set permissions

Finally, set the required permissions for your user account.

Set the following permissions:

  • Contributor
  • User Access Administrator

Set the following permissions:

  • compute.* (or the subset defined by roles/compute.instanceAdmin.v1)
  • iam.serviceAccountUser

Follow Google's guide on understanding and assigning roles.

Next Steps

You are now ready to deploy your first confidential Kubernetes cluster and application.