Skip to content

Commit

Permalink
Reorganize the README for installation clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
ironcladlou committed Mar 10, 2021
1 parent 0ceb93b commit 216108f
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,35 @@ HyperShift is deployed into an existing OpenShift cluster which will host the ma
* Admin access to an OpenShift cluster (version 4.7+) specified by the `KUBECONFIG` environment variable
* The OpenShift `oc` CLI tool
* The `hypershift` CLI tool
- An [AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) with permissions to create infrastructure for the cluster

Install HyperShift into the management cluster:

```shell
hypershift install
```

Create an IAM instance profile for your workers:
```shell
hypershift create iam aws --aws-creds ~/.aws/credentials
```
NOTE: The default profile name is `hypershift-worker-profile`. To use a different name
(for example, in a shared account), use the `--profile-name` flag and then refer
to that profile using the `--instance-profile` argument to the the `create cluster`
command when creating clusters. The worker instance profile only needs to be created
once per account and you can reuse it as needed for your clusters.

To uninstall HyperShift, run:

```shell
hypershift install --render | oc delete -f -
```

To destroy the IAM instance profile, run:
```shell
hypershift destroy iam aws --aws-creds ~/.aws/credentials
```

## How to create a hosted cluster

The `hypershift` CLI tool comes with commands to help create an example hosted cluster. The cluster will come with a node pool consisting of two workers nodes.
Expand All @@ -52,16 +68,6 @@ The `hypershift` CLI tool comes with commands to help create an example hosted c
- The `hypershift` CLI tool
- The OpenShift `oc` CLI tool.
- A valid pull secret file for the `quay.io/openshift-release-dev` repository
- An [AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) with permissions to create infrastructure for the cluster

Run the `hypershift` command to create an IAM instance profile for your workers:
```shell
hypershift create iam aws --aws-creds ~/.aws/credentials
```
NOTE: The default profile name is `hypershift-worker-profile`. To use a different name
(for example, in a shared account), use the `--profile-name` flag. The worker instance
profile only needs to be created once per account and you can reuse it as needed
for your clusters.

Run the `hypershift` command to create a cluster named `example` in the `clusters`
namespace, including the cloud infrastructure to support it.
Expand All @@ -88,11 +94,6 @@ hypershift destroy cluster \
--name example
```

To destroy the IAM instance profile, run:
```shell
hypershift destroy iam aws --aws-creds ~/.aws/credentials
```

## How to add node pools to the example cluster

**Prerequisites:**
Expand Down

0 comments on commit 216108f

Please sign in to comment.