Skip to content

Commit

Permalink
feat(docs): cleanup, remove TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
nevivurn committed Jun 10, 2024
1 parent f90070b commit 3933912
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 12 deletions.
8 changes: 8 additions & 0 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ carefully.
This service is provided for **research purposes only**. Please limit your use
to the reasons stated in your workspace application form.

## Links

- Workspace management page: [`sgs.snucse.org`][sgs]
- Registry: [`sgs-registry.snucse.org`][sgs-registry]

[sgs]: https://sgs.snucse.org
[sgs-registry]: https://sgs-registry.snucse.org

## Best-Effort

This service is provided on a best-effort basis. Bacchus volunteers will try our
Expand Down
28 changes: 18 additions & 10 deletions docs/src/usage/configure-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,40 @@

In order to access our cluster, you need to download and install Kubernetes CLI
tooling ([`kubectl`][kubectl]) and the authentication plugin
([`kubelogin`][kubelogin]).
([`kubelogin`][kubelogin]). Refer to the linked pages for installation
instructions.

[kubectl]: https://kubernetes.io/docs/tasks/tools/
[kubelogin]: https://github.com/int128/kubelogin
[sgs]: https://sgs.snucse.org

### kubectl
## Verify CLI tool installation

TODO
Verify your CLI tools were installed with the following commands. Your specific
version numbers may differ.

### kubelogin (oidc-login)
```console
$ kubectl version --client
kubectl version --client=true
Client Version: v1.30.1
Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3

TODO
$ kubectl oidc-login --version
kubelogin version v1.28.1
```

## Download the kubeconfig file

Open the SGS [workspace management page][sgs] and navigate to your "Enabled"
workspace. Click the "Download" button at the bottom of the page to download the
kubeconfig file.
Open the SGS [workspace management page][sgs] and navigate to your workspace.
Click the download button at the bottom of the page to download the kubeconfig
file.

![Download kubeconfig](configure-access/download-kubeconfig.png)

Place your downloaded kubeconfig file in the default kubeconfig location:
Place your downloaded kubeconfig file in the default kubeconfig location

- **Unix** (Linux, MacOS): `~/.kube/config`
- **Windows**: TODO
- **Windows**: `%USERPROFILE%\.kube\config`

## Verify your configuration

Expand Down
7 changes: 5 additions & 2 deletions docs/src/usage/query-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ bentley Ready <none> 31d v1.30.1
Your containers will automatically be assigned to one of the nodes your
workspace's nodegroup.

To query the available resources in your node, you can use the `kubectl describe
node` command.

```console
$ kubectl describe node bentley
Name: bentley
Expand All @@ -40,8 +43,8 @@ Allocated resources:
nvidia.com/gpu 4 4
```

In the above example output, `bentley` has the following resources available in
total:
In the above example output, you can see that `bentley` has the following
resources available in total:

| Resource | Allocatable | Allocated (Requests) |
| -------- | ----------- | --------- |
Expand Down

0 comments on commit 3933912

Please sign in to comment.