Auth
Last updated
0.42
Last updated
The Cortex CLI and Python client use the default credential provider chain to get credentials for cluster and api management. Credentials will be read in the following order of precedence:
environment variables
the name of the profile specified by AWS_PROFILE environment variable
default profile from ~/.aws/credentials
It is recommended that your AWS credentials have AdministratorAccess when running cortex cluster * commands. If you are unable to use AdministratorAccess, see the below for the minimum permissions required to run cortex cluster * commands.
After spinning up a cluster using cortex cluster up, the IAM user or role that created the cluster is automatically granted system:masters permission to the cluster's RBAC. Make sure to keep track of which IAM entity originally created the cluster.
cortex cluster commands from different IAM usersBy default, the cortex cluster * commands can only be executed by the IAM user who created the cluster. To grant access to additional IAM users, follow these steps:
Install eksctl by following these .
Determine the ARN of the IAM user that you would like to grant access to. You can get the ARN via the , or by running aws iam get-user on a machine that is authenticated as the IAM user (or AWS_ACCESS_KEY_ID=*** AWS_SECRET_ACCESS_KEY=*** aws iam get-user on any machine, using the credentials of the IAM user). The ARN should look similar to arn:aws:iam::764403040417:user/my-username.
Set the following environment variables:
Run the following command:
To revoke access in the future, run:
The Cortex CLI and Python client rely on AWS IAM to authenticate requests to a cluster on AWS (e.g. cortex deploy, cortex get). AWS credentials required to authenticate Cortex client requests to the operator don't require any specific permissions; they must only be valid credentials within the same AWS account as the Cortex cluster. However, managing the cluster (i.e. running cortex cluster * commands) does require permissions.
When spinning up a cortex cluster, you can provide additional policies to authorize your APIs to access AWS resources by creating a policy and adding it to the iam_policy_arns list in your cluster configuration file.
NOTE: The policy created during cortex cluster up will automatically be deleted during cortex cluster down. It is recommended to create your own policies that can be specified in iam_policy_arns field in cluster configuration. The precreated policy should only be updated for development and testing purposes.
The policy shown below contains the minimum permissions required to manage a Cortex cluster (i.e. via cortex cluster * commands).
Replace the following placeholders with their respective values in the policy template below: $CORTEX_CLUSTER_NAME, $CORTEX_ACCOUNT_ID, $CORTEX_REGION.
If you already have a cluster running and would like to add additional permissions, you can update the policy that is created automatically during cortex cluster up. In the , search for cortex-<cluster_name>-<region> to find the policy that has been attached to your cluster. Adding more permissions to this policy will automatically give more access to all of your Cortex APIs.