* Add STACKIT to readme and sort CSPs alphabetically in sentences * fix links
12 KiB
Installation and setup
Constellation runs entirely in your cloud environment and can be 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 CSP is Amazon Web Services (AWS), Microsoft Azure, or Google Cloud Platform (GCP)
Install the Constellation CLI
The CLI executable is available at GitHub. Install it with the following commands:
- Download the CLI:
curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/constellation-linux-amd64
-
Verify the signature (optional)
-
Install the CLI to your PATH:
sudo install constellation-linux-amd64 /usr/local/bin/constellation
- Download the CLI:
curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/constellation-linux-arm64
-
Verify the signature (optional)
-
Install the CLI to your PATH:
sudo install constellation-linux-arm64 /usr/local/bin/constellation
- Download the CLI:
curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/constellation-darwin-arm64
-
Verify the signature (optional)
-
Install the CLI to your PATH:
sudo install constellation-darwin-arm64 /usr/local/bin/constellation
- Download the CLI:
curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/constellation-darwin-amd64
-
Verify the signature (optional)
-
Install the CLI to your PATH:
sudo install constellation-darwin-amd64 /usr/local/bin/constellation
:::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.
:::tip If you don't have a cloud subscription, you can also set up a local Constellation cluster using virtualization for testing. :::
Required permissions
The following resource providers need to be registered in your subscription:
Microsoft.Attestation
[2]Microsoft.Compute
Microsoft.Insights
Microsoft.ManagedIdentity
Microsoft.Network
By default, Constellation tries to register these automatically if they haven't been registered before.
To create the IAM configuration for Constellation, you need the following permissions:
*/register/action
[1]Microsoft.Authorization/roleAssignments/*
Microsoft.Authorization/roleDefinitions/*
Microsoft.ManagedIdentity/userAssignedIdentities/*
Microsoft.Resources/subscriptions/resourcegroups/*
The built-in Owner
role is a superset of these permissions.
To create a Constellation cluster, you need the following permissions:
Microsoft.Attestation/attestationProviders/*
[2]Microsoft.Compute/virtualMachineScaleSets/*
Microsoft.Insights/components/*
Microsoft.ManagedIdentity/userAssignedIdentities/*
Microsoft.Network/loadBalancers/*
Microsoft.Network/loadBalancers/backendAddressPools/*
Microsoft.Network/networkSecurityGroups/*
Microsoft.Network/publicIPAddresses/*
Microsoft.Network/virtualNetworks/*
Microsoft.Network/virtualNetworks/subnets/*
Microsoft.Network/natGateways/*
The built-in Contributor
role is a superset of these permissions.
Follow Microsoft's guide on understanding and assigning roles.
1: You can omit */register/Action
if the resource providers mentioned above are already registered and the ARM_SKIP_PROVIDER_REGISTRATION
environment variable is set to true
when creating the IAM configuration.
2: You can omit Microsoft.Attestation/attestationProviders/*
and the registration of Microsoft.Attestation
if EnforceIDKeyDigest
isn't set to MAAFallback
in the config file.
Create a new project for Constellation or use an existing one. Enable the Compute Engine API on it.
To create the IAM configuration for Constellation, you need the following permissions:
iam.serviceAccountKeys.create
iam.serviceAccountKeys.delete
iam.serviceAccountKeys.get
iam.serviceAccounts.create
iam.serviceAccounts.delete
iam.serviceAccounts.get
resourcemanager.projects.getIamPolicy
resourcemanager.projects.setIamPolicy
Together, the built-in roles roles/editor
and roles/resourcemanager.projectIamAdmin
form a superset of these permissions.
To create a Constellation cluster, you need the following permissions:
compute.addresses.createInternal
compute.addresses.deleteInternal
compute.addresses.get
compute.addresses.useInternal
compute.backendServices.create
compute.backendServices.delete
compute.backendServices.get
compute.backendServices.use
compute.disks.create
compute.firewalls.create
compute.firewalls.delete
compute.firewalls.get
compute.globalAddresses.create
compute.globalAddresses.delete
compute.globalAddresses.get
compute.globalAddresses.use
compute.globalForwardingRules.create
compute.globalForwardingRules.delete
compute.globalForwardingRules.get
compute.globalForwardingRules.setLabels
compute.globalOperations.get
compute.healthChecks.create
compute.healthChecks.delete
compute.healthChecks.get
compute.healthChecks.useReadOnly
compute.instanceGroupManagers.create
compute.instanceGroupManagers.delete
compute.instanceGroupManagers.get
compute.instanceGroups.create
compute.instanceGroups.delete
compute.instanceGroups.get
compute.instanceGroups.use
compute.instances.create
compute.instances.setLabels
compute.instances.setMetadata
compute.instances.setTags
compute.instanceTemplates.create
compute.instanceTemplates.delete
compute.instanceTemplates.get
compute.instanceTemplates.useReadOnly
compute.networks.create
compute.networks.delete
compute.networks.get
compute.networks.updatePolicy
compute.routers.create
compute.routers.delete
compute.routers.get
compute.routers.update
compute.subnetworks.create
compute.subnetworks.delete
compute.subnetworks.get
compute.subnetworks.use
compute.targetTcpProxies.create
compute.targetTcpProxies.delete
compute.targetTcpProxies.get
compute.targetTcpProxies.use
iam.serviceAccounts.actAs
Together, the built-in roles roles/editor
, roles/compute.instanceAdmin
and roles/resourcemanager.projectIamAdmin
form a superset of these permissions.
Follow Google's guide on understanding and assigning roles.
To set up a Constellation cluster, you need to perform two tasks that require permissions: create the infrastructure and create roles for cluster nodes. Both of these actions can be performed by different users, e.g., an administrator to create roles and a DevOps engineer to create the infrastructure.
To create the IAM configuration for Constellation, you need the following permissions:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ec2:DescribeAccountAttributes",
"iam:AddRoleToInstanceProfile",
"iam:AttachRolePolicy",
"iam:CreateInstanceProfile",
"iam:CreatePolicy",
"iam:CreateRole",
"iam:DeleteInstanceProfile",
"iam:DeletePolicy",
"iam:DeletePolicyVersion",
"iam:DeleteRole",
"iam:DetachRolePolicy",
"iam:GetInstanceProfile",
"iam:GetPolicy",
"iam:GetPolicyVersion",
"iam:GetRole",
"iam:ListAttachedRolePolicies",
"iam:ListInstanceProfilesForRole",
"iam:ListPolicyVersions",
"iam:ListRolePolicies",
"iam:PassRole",
"iam:RemoveRoleFromInstanceProfile",
"sts:GetCallerIdentity"
],
"Resource": "*"
}
]
}
The built-in AdministratorAccess
policy is a superset of these permissions.
To create a Constellation cluster, see the permissions of main.tf.
The built-in PowerUserAccess
policy is a superset of these permissions.
Follow Amazon's guide on understanding and managing policies.
Authentication
You need to authenticate with your CSP. The following lists the required steps for testing and production environments.
:::note 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.
Testing
You can use the Google Cloud Shell. Make sure your session is authorized. For example, execute gsutil
and accept the authorization prompt.
Production
Use one of the following options on a trusted machine:
-
Use the
gcloud
CLIgcloud 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.
Testing
You can use the AWS CloudShell. Make sure you are authorized to use it.
Production
Use the latest version of the AWS CLI on a trusted machine:
aws configure
Options and first steps are described in the AWS CLI documentation.
Next steps
You are now ready to deploy your first confidential Kubernetes cluster and application.