Skip to content

Commit

Permalink
Merge pull request #3362 from camilamacedo86/readmed-supportability
Browse files Browse the repository at this point in the history
📖 add supportability info into README (only linux/amd64)
  • Loading branch information
camilamacedo86 authored Nov 12, 2022
2 parents 939172d + fecb356 commit 4a501c5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ curl https://kots.io/install | bash
```

### Run `kots install`

The `install` command is the recommended way to learn KOTS. Executing the `install` command will install an application and the [kotsadm](https://github.com/replicatedhq/kotsadm) Admin Console to an existing Kubernetes cluster. This command supports installing Helm charts (without Tiller), standard Kubernetes applications and also Replicated KOTS apps.

Continue with the demo by running the following command:
Expand All @@ -27,6 +28,8 @@ kubectl kots install sentry-pro

Set a namespace for the admin console and the application components to be installed, and provide a password for the admin console. After this command completes, the kotsadm Admin Console will be running in your cluster, listening on port :8800 on a ClusterIP service in the namespace you deployed the application to. By default this is exposed to your workstation using kubectl port-forward, but you could set up an ingress/load balancer of your own.

**NOTE** Currently, the kotsadm pod can **only** be scheduled on nodes with the `linux/amd64` platform.

### Access the Admin Console
Visit http://localhost:8800 to access the Admin Console, enter the password.

Expand All @@ -37,6 +40,11 @@ If you terminate your terminal session, the port-forward will also terminate. To
kubectl kots admin-console --namespace sentry-pro
```

## Supportability

Currently, the KOTS CLI supports OSX (including Apple Silicon arm64) and Linux platforms. However, the Kubernetes resources
that it creates can **only** be scheduled on nodes with the `linux/amd64` platform.

# Community

For questions about using KOTS, there's a [Replicated Community](https://help.replicated.com/community) forum, and a [#kots channel in Kubernetes Slack](https://kubernetes.slack.com/channels/kots).
Expand Down

0 comments on commit 4a501c5

Please sign in to comment.