Skip to content

Commit 0b4c2f6

Browse files
committed
docs - add Microsoft Entra Workload ID cluster installation procedure
1 parent 140ebad commit 0b4c2f6

File tree

5 files changed

+643
-9
lines changed

5 files changed

+643
-9
lines changed

docs/aws-sts-provisioning.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Provisioning AWS STS Clusters
22

3-
It is possible to use Hive to provision clusters configured to use Amazon's Security Token Service, where cluster components use short lived credentials that are rotated frequently, and the cluster does not have an admin level AWS credential. This feature was added to the in-cluster OpenShift components in 4.7, see documentation [here](https://docs.openshift.com/container-platform/4.7/authentication/managing_cloud_provider_credentials/cco-mode-sts.html).
3+
It is possible to use Hive to provision clusters configured to use Amazon's Security Token Service, where cluster components use short lived credentials that are rotated frequently, and the cluster does not have an admin level AWS credential. This feature was added to the in-cluster OpenShift components in 4.20, see documentation [here](https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/authentication_and_authorization/managing-cloud-provider-credentials#cco-short-term-creds).
44

55
At present Hive does not automate the STS setup, rather we assume the user configures STS components manually and provides information to Hive. The following instructions refer to the `ccoctl` tool. This tool can be extracted from the OpenShift release image. See steps below.
66

@@ -31,7 +31,7 @@ chmod u+x ccoctl
3131

3232
## Setup STS Infrastructure
3333

34-
Create AWS resources using the [ccoctl](ccoctl.md#steps-create) tool (you will need aws credentials with sufficient permissions). The command below will generate public/private ServiceAccount signing keys, create the S3 bucket (with public read-only access), upload the OIDC config into the bucket, set up an IAM Identity Provider that trusts that bucket configuration, and create IAM Roles for each AWS CredentialsRequest extracted above. It will also dump the files needed by the installer in the `_output` directory. Installation secret manifests will be found within `_output/manifests`.
34+
Create AWS resources using the ccoctl tool (you will need aws credentials with sufficient permissions). The command below will generate public/private ServiceAccount signing keys, create the S3 bucket (with public read-only access), upload the OIDC config into the bucket, set up an IAM Identity Provider that trusts that bucket configuration, and create IAM Roles for each AWS CredentialsRequest extracted above. It will also dump the files needed by the installer in the `_output` directory. Installation secret manifests will be found within `_output/manifests`.
3535
```
3636
./ccoctl aws create-all --name <aws_infra_name> --region <aws_region> --credentials-requests-dir ./credrequests --output-dir _output/
3737
```
@@ -54,3 +54,10 @@ Create a ClusterDeployment normally with the following changes:
5454
1. In your ClusterDeployment set `spec.boundServiceAccountSigningKeySecretRef.name` to point to the Secret created above (`bound-service-account-signing-key`).
5555
1. In your ClusterDeployment set `spec.provisioning.manifestsSecretRef` to point to the Secret created above (`cluster-manifests`).
5656
1. Create your ClusterDeployment + InstallConfig to provision your STS cluster.
57+
58+
## Note: Cleanup AWS resources after uninstalling the cluster
59+
Make sure you clean up the following resources after you uninstall your cluster. To delete resources created by ccoctl, run
60+
```bash
61+
$ ./ccoctl aws delete --name=<name> --region=<aws-region>
62+
```
63+
where name is the name used to tag and account any cloud resources that were created, and region is the aws region in which cloud resources were created.

docs/hiveutil.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,31 @@ To view what `create-cluster` generates, *without* submitting it to the API serv
1515

1616
`--release-image` can be specified to control which OpenShift release image to use.
1717

18+
#### Pull Secret
19+
20+
A pull secret is required for all cluster deployments. The pull secret can be obtained from https://console.redhat.com/openshift/install/pull-secret.
21+
22+
The `create-cluster` command will look for the pull secret in the following order of precedence:
23+
24+
1. `PULL_SECRET` environment variable
25+
2. `--pull-secret` command line parameter (pull secret content as a string)
26+
3. `--pull-secret-file` command line parameter (path to file containing pull secret)
27+
4. Default file location: `~/.pull-secret` (if the file exists)
28+
29+
If none of these are provided and no global pull secret is configured in HiveConfig, the cluster deployment will be created but installation will fail with an error about missing pull secret.
30+
31+
**Best Practice:** Save your pull secret to `~/.pull-secret` for convenient reuse:
32+
33+
```bash
34+
# Download pull secret from console.redhat.com and save it
35+
cat > ~/.pull-secret << 'EOF'
36+
{"auths":{"xxxx":{"auth":"...","email":"..."}}}
37+
EOF
38+
39+
# Or specify it explicitly when creating a cluster
40+
bin/hiveutil create-cluster mycluster --pull-secret-file=/path/to/pull-secret
41+
```
42+
1843
#### Create Cluster on AWS
1944

2045
Credentials will be read from your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables. If the environment variables are missing or empty, then `create-cluster` will look for creds at `~/.aws/credentials`. Alternatively you can specify an AWS credentials file with `--creds-file`.

docs/install.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ Sample output:
4444
4545
```bash
4646
$ oc get pods -n hive
47-
NAME READY STATUS RESTARTS AGE
48-
hive-clustersync-0 1/1 Running 0 16m
49-
hive-controllers-6fcbf74864-hdn27 1/1 Running 0 17m
50-
hive-operator-7b877b996b-ndlpj 1/1 Running 0 17m
51-
hiveadmission-7969fd9dd-l24jb 1/1 Running 0 17m
52-
hiveadmission-7969fd9dd-pl2ml 1/1 Running 0 17m
47+
hive-clustersync-0 1/1 Running 0 34s
48+
hive-controllers-5d67988cc8-97r5p 1/1 Running 0 35s
49+
hive-machinepool-0 1/1 Running 0 34s
50+
hive-operator-5c7fdd6df8-jrxvt 1/1 Running 0 3m30s
51+
hiveadmission-5bf565bd7-nqq9h 1/1 Running 0 32s
52+
hiveadmission-5bf565bd7-tkf4c 1/1 Running 0 32s
5353
```
5454

5555
# Next Step

0 commit comments

Comments
 (0)