Skip to content

Commit 6a4c42c

Browse files
author
Lukas Gentele
committed
docs: add getting started
1 parent f6e569a commit 6a4c42c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1220
-342
lines changed

Diff for: .gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
* linguist-vendored
22
*.go linguist-vendored=false
3+
*.mp4 filter=lfs diff=lfs merge=lfs -text

Diff for: docs/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
"deploy": "docusaurus deploy"
1010
},
1111
"dependencies": {
12-
"@docusaurus/core": "^2.0.0-alpha.55",
13-
"@docusaurus/preset-classic": "^2.0.0-alpha.55",
12+
"@docusaurus/core": "^2.0.0-alpha.56",
13+
"@docusaurus/preset-classic": "^2.0.0-alpha.56",
1414
"classnames": "^2.2.6",
1515
"mdx-link-checker": "^0.0.7",
1616
"react": "^16.8.4",

Diff for: docs/pages/administration/uninstall.mdx

+19
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,22 @@
22
title: Uninstall loft
33
sidebar_label: Uninstall loft
44
---
5+
6+
## Delete Helm Release
7+
```bash
8+
helm delete -n loft loft
9+
```
10+
11+
## Delete Namespace (optional)
12+
```bash
13+
kubectl delete ns loft
14+
```
15+
16+
## Delete CRDs (optional)
17+
```bash
18+
kubectl api-resources --api-group='storage.loft.sh' -o name | xargs kubectl delete crd
19+
```
20+
21+
:::warning Data Loss
22+
Deleting the loft CRDs will also remove all loft objects inside your cluster, e.g. `Cluster`, `Team`, `User`. This **cannot** be undone.
23+
:::

Diff for: docs/pages/administration/upgrade.mdx

+7-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ title: Upgrade loft
33
sidebar_label: Upgrade loft
44
---
55

6+
Make sure you are in the kube-context of your loft management cluster and run the following command using helm v3:
67
```bash
7-
helm upgrade -n loft loft loft --repo https://charts.devspace.sh --reuse-values --version v0.0.1-beta.26
8-
```
8+
helm upgrade -n loft loft loft --repo https://charts.devspace.sh --reuse-values --version 0.0.1
9+
```
10+
11+
:::important Version Numbers
12+
Make sure to use version numbers without the `v` prefix.
13+
:::

Diff for: docs/pages/fragments/change-default-limits.mdx

-12
This file was deleted.

Diff for: docs/pages/fragments/change-user-limits.mdx

-6
This file was deleted.

Diff for: docs/pages/fragments/connect-cluster.mdx

-23
This file was deleted.

Diff for: docs/pages/fragments/connect-cluster/kube-config.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
**Option A:** To automatically create a kube-config using [loft CLI](#TODO), run the following command:
3+
```bash
4+
loft generate admin-kube-config
5+
```
6+
**Note:** Make sure you are in the right cluster/context before executing the command shown above.
7+
8+
**Option B:** To manually create a kube-config, you need to:
9+
1. Create a ServiceAccount
10+
2. Create a ClusterRoleBinding to bind the ServiceAccount to the ClusterRole `cluster-admin`
11+
3. Create a kube-config for the cluster using the token of the ServiceAccount created above

Diff for: docs/pages/fragments/connect-cluster/name.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Enter a name for your cluster. This name must be a Kubernetes-compatible object name, i.e. only lowercase characters and dashes are allowed.
2+
3+
:::note Naming
4+
Cluster names should tell engineers what the cluster is used for and where it is located, e.g. `gke-prod`, `gke-dev-tpu-us-1`, `eks-dev-us-west-1`
5+
:::

Diff for: docs/pages/fragments/create-space.mdx

-39
This file was deleted.

Diff for: docs/pages/fragments/install/cli.mdx

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
import Tabs from '@theme/Tabs'
2+
import TabItem from '@theme/TabItem'
3+
4+
15
<Tabs
26
groupId="platform"
3-
defaultValue="npm"
7+
defaultValue="mac"
48
values={[
5-
{ label: 'npm', value: 'npm', },
6-
{ label: 'yarn', value: 'yarn', },
9+
// { label: 'npm', value: 'npm', },
10+
// { label: 'yarn', value: 'yarn', },
711
{ label: 'Mac Terminal', value: 'mac', },
812
{ label: 'Linux Bash', value: 'linux', },
913
{ label: 'Windows Powershell', value: 'windows', },

Diff for: docs/pages/fragments/install/create-admin-user.mdx

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@ After deploying loft, `helm install` will show an output similar to this one:
22

33
```bash
44
########## Set Admin Password ##########
5-
https://invite?token=[RESET_PASSWORD_TOKEN]
5+
https://loft.my-domain.tld/invite?token=[RESET_PASSWORD_TOKEN]
66
########################################
77
```
88

99
Copy the link from the terminal output and open it in the browser to configure your admin account.
1010

11+
<figure class="frame">
12+
<video controls loop autoplay="true" muted>
13+
<source src="/img/ui/auth/create-admin-user.mp4" type="video/mp4" />
14+
</video>
15+
<figcaption>loft UI - Create Admin User</figcaption>
16+
</figure>
17+
1118
:::note
1219
If you lost the output of the `helm install` command, run the following command to view it again:
1320
```bash

Diff for: docs/pages/fragments/install/create-namespace.mdx

-5
This file was deleted.

0 commit comments

Comments
 (0)