Skip to content

Commit

Permalink
Merge c643fe1 into a3841d2
Browse files Browse the repository at this point in the history
  • Loading branch information
eytan-avisror authored Jan 30, 2021
2 parents a3841d2 + c643fe1 commit b3ff596
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,7 @@ _For installation instructions and more examples of usage, please refer to the [

## Usage example

### Currently supported provisioners

| Provisioner | Description | Examples |
| :---------- | :---------- | :----------|
| eks | provision nodes on EKS | [EKS.md](./docs/examples/EKS.md)|
| eks-managed | provision managed node groups on EKS| [EKS-managed.md](./docs/examples/EKS-managed.md) |
| eks-fargate | provision a cluster to run pods on EKS Fargate| [EKS-fargate.md](./docs/examples/EKS-fargate.md) |

To create an instance group, submit an InstanceGroup custom resource in your cluster, and the controller will provision and bootstrap it to your cluster, and allow you to modify it from within the cluster.

### Submit and Verify
![Demo](./docs/demo.gif)

```bash
$ kubectl create -f instance_group.yaml
Expand All @@ -55,7 +45,7 @@ NAMESPACE NAME STATE MIN MAX GROUP NAME PR
instance-manager hello-world ReconcileModifying 3 6 hello-world eks crd normal 1m
```

some time later, once the cloudformation stacks are created
some time later, once the scaling groups are created

```bash
$ kubectl get instancegroups
Expand All @@ -74,6 +64,16 @@ ip-10-10-10-30.us-west-2.compute.internal Ready hello-world 32s v1.14.
ip-10-10-10-40.us-west-2.compute.internal Ready hello-world 32s v1.14.6-eks-5047ed
```

### Currently supported provisioners

| Provisioner | Description | Examples |
| :---------- | :---------- | :----------|
| eks | provision nodes on EKS | [EKS.md](./docs/examples/EKS.md)|
| eks-managed | provision managed node groups on EKS| [EKS-managed.md](./docs/examples/EKS-managed.md) |
| eks-fargate | provision a cluster to run pods on EKS Fargate| [EKS-fargate.md](./docs/examples/EKS-fargate.md) |

To create an instance group, submit an InstanceGroup custom resource in your cluster, and the controller will provision and bootstrap it to your cluster, and allow you to modify it from within the cluster.

### Alpha-2 Version

Please consider that this project is in alpha stages and breaking API changes may happen, we will do our best to not break backwards compatiblity without a deprecation period going further.
Expand Down
2 changes: 1 addition & 1 deletion docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ NAMESPACE NAME STATE MIN MAX GROUP NAME PR
instance-manager hello-world ReconcileModifying 3 6 hello-world eks crd normal 1m
```

some time later, once the cloudformation stacks are created.
some time later, once the scaling groups are created.

```bash
$ kubectl get instancegroups
Expand Down
Binary file added docs/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b3ff596

Please sign in to comment.