Skip to content
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.

Sign up for GitHub

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

Jump to bottom

📖 add supportability info into README (only linux/amd64) #3362

Merged
merged 3 commits into from
Nov 12, 2022
Merged

📖 add supportability info into README (only linux/amd64) #3362

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71bffe0
:book: add supportability info into README (only linux/amd64)
camilamacedo86 Oct 27, 2022
20c8f64
Update README.md
camilamacedo86 Nov 10, 2022
fecb356
Update README.md
camilamacedo86 Nov 10, 2022
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
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