mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00

2022-09-02 11:52:42 +02:00

7.7 KiB

Raw Blame History

Installation and Setup

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

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

Prerequisites

Before we start, make sure the following requirements are fulfilled:

Your machine is running Ubuntu or macOS
You have admin rights on your machine
kubectl is installed
Your cloud provider is Microsoft Azure or Google Cloud

Install the Constellation CLI

The Constellation CLI can be downloaded from our release page. Therefore, navigate to a release and download the file constellation. Move the downloaded file to a directory in your PATH (default: /usr/local/bin) and make it executable by entering chmod s+x constellation in your terminal.

Running constellation should then give you:

$ constellation
Manage your Constellation cluster.

Usage:
  constellation [command]

...

Optional: Enable shell autocompletion

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

Verify the CLI

For extra security, make sure to verify your CLI. Therefore, install cosign. Then, head to our release page again and, from the same release as before, download the following files:

cosign.pub (Edgeless System's cosign public key)
constellation.sig (the CLI's signature)

You can then verify your CLI before launching a cluster using the paths to the public key, signature, and CLI executable:

cosign verify-blob --key cosign.pub --signature constellation.sig constellation

For more detailed information read our installation, update and verification documentation.

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.

Authentication

In the following, we provide you with different ways to authenticate with your CSP.

:::danger

Don't use the testing methods for setting up a production-grade Constellation cluster. In those methods, secrets are stored on disk during installation which would be exposed to the CSP.

:::

Testing

To try out Constellation, using a cloud environment such as Azure Cloud Shell is the quickest way to get started.

Production

For production clusters, use 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 a Google VM, 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 clusters, 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 then 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.

Authorization

Your user account needs the following permissions to set up a Constellation cluster:

Contributor
User Access Administrator

Additionally, you need to create a user-assigned managed identity with the following roles:

Virtual Machine Contributor
Application Insights Component Contributor

The user-assigned identity is used by the instances of the cluster to access other cloud resources.

You also need an empty resource group per cluster. Notice that the user-assigned identity has to be created in a different resource group as all resources within the cluster resource group will be deleted on cluster termination.

Last, you need to create an Active Directory app registration (you don't need to add a redirect URI). As supported account types choose 'Accounts in this organizational directory only'. Then create a client secret, which will be used by Kubernetes. On the cluster resource group, add the app registration with role Owner.

User-assigned identity, cluster resource group, app registration client ID and client secret value need to be set in the constellation-conf.yaml configuration file.

Your user account needs the following permissions to set up a Constellation:

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

Follow Google's guide on understanding and assigning roles.

Additionally, you need a service account with the following permissions:

Compute Instance Admin (v1) (roles/compute.instanceAdmin.v1)
Compute Network Admin (roles/compute.networkAdmin)
Compute Security Admin (roles/compute.securityAdmin)
Compute Storage Admin (roles/compute.storageAdmin)
Service Account User (roles/iam.serviceAccountUser)

The key for this service account is passed to the CLI and used by Kubernetes to authenticate with the cloud. You can configure the path to the key in the constellation-conf.yaml configuration file.

GCP instances come with a default service account attached that's used by the instances to access the cloud resources of the cluster. You don't need to configure it.

Troubleshooting

If you receive an error during any of the outlined steps, please verify that you have executed all previous steps in this documentation. Also, feel free to ask our active community on Discord for help.

Next Steps

Once you have followed all previous steps, you can proceed to deploy your first confidential Kubernetes cluster and application.

7.7 KiB Raw Blame History