Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Add getting started guide for unmanaged cluster #2820

Merged
merged 2 commits into from
Feb 17, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
68 changes: 68 additions & 0 deletions docs/site/content/docs/assets/create-unmanaged-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
1. Create a cluster named `beepboop`.

```sh
tanzu unmanaged-cluster create beepboop
```

> **Tip**: You can use the alias `uc`, instead of `unmanaged-cluster`, in
> these commands.

1. Wait for the cluster to initialize.

```txt
📁 Created cluster directory

🔧 Resolving Tanzu Kubernetes Release (TKR)
projects.registry.vmware.com/tce/tkr:v1.21.5
TKR exists at /home/josh/.config/tanzu/tkg/unmanaged-cluster/bom/projects.registry.vmware.com_tce_tkr_v1.21.5
Rendered Config: /home/josh/.config/tanzu/tkg/unmanaged-cluster/beepboop/config.yaml
Bootstrap Logs: /home/josh/.config/tanzu/tkg/unmanaged-cluster/beepboop/bootstrap.log

🔧 Processing Tanzu Kubernetes Release

🎨 Selected base image
projects.registry.vmware.com/tce/kind/node:v1.21.5

📦 Selected core package repository
projects.registry.vmware.com/tkg/packages/core/repo:v1.21.2_vmware.1-tkg.1

📦 Selected additional package repositories
projects.registry.vmware.com/tce/main:0.9.1

📦 Selected kapp-controller image bundle
projects.registry.vmware.com/tkg/packages/core/kapp-controller:v0.23.0_vmware.1-tkg.1

🚀 Creating cluster beepboop
Base image downloaded
Cluster created
To troubleshoot, use:
kubectl ${COMMAND} --kubeconfig /home/josh/.config/tanzu/tkg/unmanaged-cluster/beepboop/kube.conf

📧 Installing kapp-controller
kapp-controller status: Running

📧 Installing package repositories
Core package repo status: Reconcile succeeded

🌐 Installing CNI
antrea.tanzu.vmware.com:0.13.3+vmware.1-tkg.1

✅ Cluster created

🎮 kubectl context set to beepboop

View available packages:
tanzu package available list
View running pods:
kubectl get po -A
Delete this cluster:
tanzu unmanaged-cluster delete beepboop
```

> A container image larger than 1GB is used for running clusters. This may
> cause your first cluster to take significantly longer to bootstrap than
> subsequent clusters.

1. If you have [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
installed, you can now use it to interact with the
cluster.
24 changes: 24 additions & 0 deletions docs/site/content/docs/assets/delete-unmanaged-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
1. List the available clusters.

```sh
tanzu unmanaged-cluster list
```

> **Tip**: You can use the alias `ls`, instead of `list`, in
> the above command.

1. Review the available clusters.

```txt
NAME PROVIDER
beepboop kind
```

1. Delete the cluster.

```sh
tanzu unmanaged-cluster delete beepboop
```

> **Tip**: You can use the alias `rm`, instead of `delete`, in
> the above command.
4 changes: 4 additions & 0 deletions docs/site/content/docs/assets/direct-download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
If you prefer to not use a package manager, you can download releases [on
GitHub](https://github.com/vmware-tanzu/community-edition/releases). Download
and unpack the release for your operating system. Then, run the script
`install.sh` (linux/mac) or `install.bat` (windows) inside.
15 changes: 15 additions & 0 deletions docs/site/content/docs/assets/install-homebrew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
1. Install using [homebrew](https://brew.sh).

```sh
brew install vmware-tanzu/tanzu/tanzu-community-edition
```

1. Run the configure command displayed after homebrew completes installation.

```sh
{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh
```

> This puts all the Tanzu plugins in the correct location. The first time
> you run the `tanzu` command the installed plugins and plugin repositories
> are initialized. This action might take a minute.
75 changes: 75 additions & 0 deletions docs/site/content/docs/assets/install-package-to-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
1. List the available package repositories.

```sh
tanzu package repository list --all-namespaces
```

1. Verify the `STATUS` is `Reconcile succeeded` in the output of the above
command.

```txt
NAME REPOSITORY TAG STATUS DETAILS NAMESPACE
tkg-core-repository projects.registry.vmware.com/tce/main 0.9.1 Reconcile succeeded tanzu-package-repo-global
tkg-core-repository projects.registry.vmware.com/tkg/packages/core/repo v1.21.2_vmware.1-tkg.1 Reconcile succeeded tkg-system
```

1. List the available packages.

```sh
tanzu package available list
```

```txt
NAME DISPLAY-NAME SHORT-DESCRIPTION
cert-manager.community.tanzu.vmware.com cert-manager Certificate management
contour.community.tanzu.vmware.com Contour An ingress controller
external-dns.community.tanzu.vmware.com external-dns This package provides DNS synchronization functionality.
fluent-bit.community.tanzu.vmware.com fluent-bit Fluent Bit is a fast Log Processor and Forwarder
gatekeeper.community.tanzu.vmware.com gatekeeper policy management
grafana.community.tanzu.vmware.com grafana Visualization and analytics software
harbor.community.tanzu.vmware.com Harbor OCI Registry
knative-serving.community.tanzu.vmware.com knative-serving Knative Serving builds on Kubernetes to support deploying and serving of applications and functions as serverless containers
local-path-storage.community.tanzu.vmware.com local-path-storage This package provides local path node storage and primarily supports RWO AccessMode.
multus-cni.community.tanzu.vmware.com multus-cni This package provides the ability for enabling attaching multiple network interfaces to pods in Kubernetes
prometheus.community.tanzu.vmware.com prometheus A time series database for your metrics
velero.community.tanzu.vmware.com velero Disaster recovery capabilities
```

1. List the available versions of cert-manager.

```sh
tanzu package available list cert-manager.community.tanzu.vmware.com
```

```txt
NAME VERSION RELEASED-AT
cert-manager.community.tanzu.vmware.com 1.3.3 2021-08-06 05:31:21 -0700 MST
cert-manager.community.tanzu.vmware.com 1.4.4 2021-08-23 09:47:51 -0700 MST
cert-manager.community.tanzu.vmware.com 1.5.3 2021-08-23 10:22:51 -0700 MST
```

1. Install the `1.5.3` version of cert-manager.

```sh
tanzu package install cert-manager --package-name cert-manager.community.tanzu.vmware.com --version 1.5.3
```

> If you have `kubectl` installed, you can now view and interact with
> cert-manager.

1. Verify the package is now installed.

```sh
tanzu package installed list
```

```txt
NAME PACKAGE-NAME PACKAGE-VERSION STATUS
cert-manager cert-manager.community.tanzu.vmware.com 1.5.3 Reconcile succeeded
```

1. If desired, you can also delete the package using:

```sh
tanzu package installed delete cert-manager
```
3 changes: 3 additions & 0 deletions docs/site/content/docs/assets/prereq-unmanaged-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| Architecture | CPU | RAM | Required software |
|:---------------|:----|:-----|:------------------|
| x86_64 / amd64 | 1 | 2 GB | [Docker engine](https://docs.docker.com/engine/install) |
3 changes: 3 additions & 0 deletions docs/site/content/docs/assets/prereq-unmanaged-mac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| Architecture | CPU | RAM | Required software |
|:---------------|:----|:-----|:------------------|
| x86_64 / amd64 | 1 | 2 GB | [Docker Desktop](https://www.docker.com/get-started) |
3 changes: 3 additions & 0 deletions docs/site/content/docs/assets/prereq-unmanaged-windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| Architecture | CPU | RAM | Required software |
|:---------------|:----|:-----|:------------------|
| x86_64 / amd64 | 1 | 2 GB | [Docker Desktop](https://www.docker.com/get-started) |
3 changes: 3 additions & 0 deletions docs/site/content/docs/assets/unmanaged-desc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Unmanaged clusters offer Tanzu environments for **development** and
**experimentation**. By default, they run locally via [kind](https://kind.sigs.k8s.io) with Tanzu components installed atop. If you're interested in running cluster(s) in a production-ready context, see
our guidance around [managed-clusters](../getting-started).
85 changes: 85 additions & 0 deletions docs/site/content/docs/latest/getting-started-unmanaged.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Getting Started with Unmanaged Clusters

<!-- markdownlint-disable MD036 -->
<!-- markdownlint-disable MD024 -->

{{% include "/docs/assets/unmanaged-desc.md" %}}

## Install Tanzu CLI

The `tanzu` CLI is used for deploying and managing Tanzu Community Edition.
Choose your operating system below for guidance on installation.

{{< tabs tabTotal="3" tabID="1" tabName1="Linux" tabName2="Mac" tabName3="Windows">}}
{{< tab tabNum="1" >}}

### Linux System Requirements

{{% include "/docs/assets/prereq-unmanaged-linux.md" %}}

### Package Manager

**Homebrew**

{{% include "/docs/assets/install-homebrew.md" %}}

### Direct Download

{{% include "/docs/assets/direct-download.md" %}}

{{< /tab >}}
{{< tab tabNum="2" >}}

### Mac System Requirements

{{% include "/docs/assets/prereq-unmanaged-mac.md" %}}

### Package Manager

**Homebrew**

{{% include "/docs/assets/install-homebrew.md" %}}

### Direct Download

{{% include "/docs/assets/direct-download.md" %}}

{{< /tab >}}
{{< tab tabNum="3" >}}

### Windows System Requirements

{{% include "/docs/assets/prereq-unmanaged-windows.md" %}}

### Package Manager

**Chocolatey**

1. Install using [chocolatey](https://chocolatey.org/install), in **Powershell, as an administrator**.

```sh
choco install tanzu-community-edition
```

### Direct Download

{{% include "/docs/assets/direct-download.md" %}}

{{< /tab >}}
{{< /tabs >}}

## Deploy a Cluster

{{% include "/docs/assets/create-unmanaged-cluster.md" %}}

## Deploy a Package

{{% include "/docs/assets/install-package-to-cluster.md" %}}

## Delete a Cluster

{{% include "/docs/assets/delete-unmanaged-cluster.md" %}}

## Next Steps

* [Unmanaged Clusters Reference Documentation](/docs/latest/ref-unmanaged-cluster)
Loading