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.

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

Add helm repo installation doc #348

Merged
merged 11 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
1 change: 1 addition & 0 deletions docs/content/en/boilerplates/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Load image to kind cluster:

```console
kind load docker-image ghcr.io/kurator-dev/cluster-operator:{{< kurator-version >}} --name kurator-host
kind load docker-image ghcr.io/kurator-dev/fleet-manager:{{< kurator-version >}} --name kurator-host
```
7 changes: 4 additions & 3 deletions docs/content/en/boilerplates/install-cluster-operator.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Install cluster operator into the management cluster.

```console
# Please make sure cert manager is ready before install cluster operator
helm install --create-namespace kurator-cluster-operator out/charts/cluster-operator-{{< kurator-version >}}.tgz -n kurator-system
helm install --create-namespace kurator-cluster-operator cluster-operator-{{< kurator-version >}}.tgz -n kurator-system
hzxuzhonghu marked this conversation as resolved.
Show resolved Hide resolved
```

After a while, you can see kurator cluster operator running.
Verify the cluster operator chart installation:

```bash
$ kubectl get pod -n kurator-system
Expand Down
8 changes: 5 additions & 3 deletions docs/content/en/boilerplates/install-fleet-manager.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Install fleet manager into the management cluster.

```console
helm install --create-namespace kurator-fleet-manager out/charts/fleet-manager-{{< kurator-version >}}.tgz -n kurator-system
helm install --create-namespace kurator-fleet-manager fleet-manager-{{< kurator-version >}}.tgz -n kurator-system
hzxuzhonghu marked this conversation as resolved.
Show resolved Hide resolved
```

After a while, you can see kurator fleet manager running.
Verify the fleet manager chart installation:

```bash
$ kubectl get pod -l app.kubernetes.io/name=kurator-fleet-manager -n kurator-system
kubectl get pod -l app.kubernetes.io/name=kurator-fleet-manager -n kurator-system
NAME READY STATUS RESTARTS AGE
kurator-fleet-manager-d587f54b6-d4ldd 1/1 Running 0 53s
```
24 changes: 6 additions & 18 deletions docs/content/en/docs/setup/insatll-kurator.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,11 @@ And then move the executable binary to your PATH.

## Install from release package

1. Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.
Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.

```console
curl -L https://github.com/kurator-dev/kurator/releases/download/{{< kurator-version >}}/kurator-{{< kurator-version >}}.tar.gz
tar -zxvf kurator-{{< kurator-version >}}.tar.gz
```

1. Move to release package directory.

```console
cd kurator-{{< kurator-version >}}
```

kurator binary is under `bin/` directory, and cluster operator helm chart is under `charts` directory.

1. Add kurator to your PATH
```console
curl -L https://github.com/kurator-dev/kurator/releases/download/v{{< kurator-version >}}/kurator-{{< kurator-version >}}-linux-amd64.tar.gz
tar -zxvf kurator-{{< kurator-version >}}-linux-amd64.tar.gz
```

```console
export PATH=$PWD/bin:$PATH
```
kurator binary is in the current directory, move it to your user PATH
31 changes: 19 additions & 12 deletions docs/content/en/docs/setup/install-cluster-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,36 @@ description: >

{{< boilerplate build-from-source >}}

Install cluster operator into the management cluster.

Change directory to the helm charts

```bash
cd out/charts/
```

{{< boilerplate install-cluster-operator >}}


## Install cluster operator from release package

Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.

1. Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.
```bash
curl -L https://github.com/kurator-dev/kurator/releases/download/v{{< kurator-version >}}/cluster-operator-{{< kurator-version >}}.tgz
```

```console
curl -L https://github.com/kurator-dev/kurator/releases/download/{{< kurator-version >}}/kurator-{{< kurator-version >}}.tar.gz
tar -zxvf kurator-{{< kurator-version >}}.tar.gz
```
{{< boilerplate install-cluster-operator >}}

1. Move to release package directory.
## Install cluster operator from helm repo

```console
cd kurator-{{< kurator-version >}}
```
Configure the Helm repository:

1. Install cluster operator into the management cluster.
```bash
helm repo add kurator https://kurator-dev.github.io/helm-charts
helm repo update
```

{{< boilerplate install-cluster-operator >}}
{{< boilerplate install-cluster-operator >}}

## Try to deploy a cluster with cluster operator

Expand Down
44 changes: 20 additions & 24 deletions docs/content/en/docs/setup/install-fleet-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Fleet manager depends on [Fluxcd](https://fluxcd.io/flux/), Kurator use helm cha

Setup with following command:

```console
```bash
helm repo add fluxcd-community https://fluxcd-community.github.io/helm-charts

cat <<EOF | helm install fluxcd fluxcd-community/flux2 --version 2.7.0 -n fluxcd-system --create-namespace -f -
Expand All @@ -31,48 +31,44 @@ EOF

Check the controller status:

```console
```bash
kubectl get po -n fluxcd-system
```

## Install fleet manager from source

Build fleet manager image and helm chart:

```console
VERSION={{< kurator-version >}} make docker
VERSION={{< kurator-version >}} make gen-chart
```
{{< boilerplate build-from-source >}}

Load image to kind cluster:
Change directory to the helm charts

```console
kind load docker-image ghcr.io/kurator-dev/fleet-manager:{{< kurator-version >}} --name kurator-host
```bash
cd out/charts/
```

Install fleet manager into the management cluster.

{{< boilerplate install-fleet-manager >}}

## Install fleet manager from release package

Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.

```bash
curl -L https://github.com/kurator-dev/kurator/releases/download/v{{< kurator-version >}}/fleet-manager-{{< kurator-version >}}.tgz
```

1. Go to [Kurator release](https://github.com/kurator-dev/kurator/releases) page to download the release package for your OS and extract.

```console
curl -L https://github.com/kurator-dev/kurator/releases/download/{{< kurator-version >}}/kurator-{{< kurator-version >}}.tar.gz
tar -zxvf kurator-{{< kurator-version >}}.tar.gz
```
{{< boilerplate install-fleet-manager >}}

1. Move to release package directory.

```console
cd kurator-{{< kurator-version >}}
```
## Install fleet manager from helm repo

1. Install fleet manager into the management cluster.
Configure the Helm repository:

{{< boilerplate install-fleet-manager >}}
```bash
helm repo add kurator https://kurator-dev.github.io/helm-charts
helm repo update
```

{{< boilerplate install-fleet-manager >}}

## Try to create a fleet with fleet manager

Expand Down
2 changes: 1 addition & 1 deletion hack/release-artifacts.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ BINS=("kurator")
# tar kurator binary
for BIN in "${BINS[@]}"; do
echo "TAR BINARY: ${BIN}"
BIN_RELEASE="${BIN}_${VERSION}_${GOOS}-${GOARCH}.tar.gz"
BIN_RELEASE="${BIN}-${VERSION}-${GOOS}-${GOARCH}.tar.gz"
pushd "${OUT_BASE_PATH}/${GOOS}-${GOARCH}/"
tar -zcvf "${BIN_RELEASE}" "./${BIN}"
popd
Expand Down
Loading