Before you can start installing your Kubernetes cluster and applications with the Plural CLI, you will need to make sure that your cloud provider CLI is set up correctly.
Info:
If you have already configured and installed your cloud provider CLI and are still seeing errors, make sure that you are on the latest version of the CLI.
Installation
Follow the provider-specific instructions below.
- Follow the instructions here to install your AWS cli.
- Verify that the cli has been added to your
$PATH
- Follow the instructions here to configure your cli and connect it to your aws console
- Verify that your cli has been properly configured by running
aws configure list
You should see a set of values that looks like this:
Name Value Type Location ---- ----- ---- -------- profile <not set> None None access_key ****************RUG2 shared-credentials-file secret_key ****************hJUU shared-credentials-file region us-east-2 config-file ~/.aws/config
If you are deploying to an AWS account with SSO enabled, you'll need to pass that specific AWS profile to the Plural CLI, or it won't be able to create resources on your behalf. You can do this with the following two steps:
- Run
export AWS_PROFILE=profile_name
to set this variable for your terminal session. - Run
aws sso login
to open your relevant SSO auth page and log in.
If you need to update your AWS CLI for any reason, make sure to run plural wkspace kube-init
to regenerate your kubeconfig to be compatible with the changes. This will be required if you're on a new machine, were using a different Kubernetes cluster, or if the kubeconfig has stale credentials.
Permissions
Since Plural is responsible for creating over 50 different applications, what permissions are required will vary based on what you're deploying. In most cases, Admin
access is the simplest to use. For example, when provisioning Airbyte, we'll need to create an IAM role and IRSA binding to the EKS control plane, which is an Admin
only action.
Service Account Permissions
When deploying via GCP, you may run into a Terraform error around permissions. Plural will need to create a various set of resources in order to make sure that your Kubernetes cluster is configured correctly. We recommend attaching the following permission roles to the service account associated with your CLI or Cloud Shell:
owner
storage.admin
Follow these steps to authorize your GCloud CLI with a new or existing Service Account.