Skip to content

[HWORKS-2243] add more detail #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/setup_installation/admin/roleChaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this document we will see how to configure AWS and Hopsworks to use Role chai
Before you begin this guide you'll need the following:

- A Hopsworks cluster running on EKS.
- Enabled IAM OpenID Connect (OIDC) provider for your cluster.
- Enabled IAM [OpenID Connect (OIDC) provider](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) for your cluster.
- Administrator account on the Hopsworks cluster.

### Step 1: Create an IAM role and associate it with a Kubernetes service account
Expand All @@ -21,6 +21,18 @@ For more details on how to create an IAM roles for Kubernetes service accounts s
!!!note
To ensure that users can't use the service account role and impersonate the roles by their own means, you need to ensure that the service account is only attached to the hopsworks instance pods.

```sh
account_id=$(aws sts get-caller-identity --query "Account" --output text)
oidc_provider=$(aws eks describe-cluster --name my-cluster --region $AWS_REGION --query "cluster.identity.oidc.issuer" --output text | sed -e "s/^https:\/\///")

```


```sh
export namespace=hopsworks
export service_account=my-service-account

```

```json
{
Expand Down Expand Up @@ -89,7 +101,7 @@ For the service account role to be able to impersonate the roles you also need t
]
}
```
<figcaption>Example trust-policy document.</figcaption>
<figcaption>Example resource roles.</figcaption>

### Step 3: Create mappings
Now that the service account IAM role can assume the roles we need to configure Hopsworks to delegate access to the roles on a project base.
Expand Down