Kubeapps + TCE tutorial #5068
Merged
Kubeapps + TCE tutorial #5068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 10 commits
July 8, 2022 09:26
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
✅ Deploy Preview for kubeapps-dev ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
added 3 commits
July 12, 2022 16:01
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
antgamdia
approved these changes
Jul 14, 2022
There was a problem hiding this comment.
Thanks so much for writing up this guide. Find below a bunch of minor comments, but +1ing anyway.
Style: mixing "we ... something" and "you.... something" structures
Did you run the linters?
vale --config ./vale.ini ./content/
npx check-html-links ./public/
npx markdownlint-cli .\content\docs\latest\ --disable MD013 MD033 --fix
npx prettier --write .\content\docs\latest\
|
|
||
| - **Managed clusters** | ||
|
|
||
| This is the primary deployment model for clusters in the Tanzu ecosystem and is recommended for production scenarios. |
There was a problem hiding this comment.
This sentence seems a bit unclear to me. Perhaps adding some links to TCE ?
|
|
||
| Offer a single node, local workstation cluster suitable for a development/test environment. | ||
|
|
||
| In this step of the tutorial, we will prepare the installation of the TCE cluster. |
There was a problem hiding this comment.
Which type of cluster ? Managed or unmanaged or both?
site/content/docs/latest/tutorials/kubeapps-on-tce/01-TCE-cluster-preparation.md
Outdated
Show resolved
Hide resolved
site/content/docs/latest/tutorials/kubeapps-on-tce/01-TCE-cluster-preparation.md
Outdated
Show resolved
Hide resolved
|
|
||
| [VMware Tanzu™ Community Edition (TCE)](https://tanzucommunityedition.io) is a full-featured, easy-to-manage Kubernetes platform for learners and users. It is a freely available, community supported, open source distribution of VMware Tanzu that can be installed and configured in minutes on your local workstation or your favorite cloud. | ||
|
|
||
| [Kubeapps](https://kubeapps.com/) provides a cloud native dashboard to deploy, manage, and upgrade applications on a Kubernetes cluster. It is a one-time install that gives you a number of important benefits, including the ability to: |
There was a problem hiding this comment.
Suggested change
| [Kubeapps](https://kubeapps.com/) provides a cloud native dashboard to deploy, manage, and upgrade applications on a Kubernetes cluster. It is a one-time install that gives you a number of important benefits, including the ability to: | |
| [Kubeapps](https://kubeapps.com/) provides a cloud-native dashboard to deploy, manage, and upgrade applications on a Kubernetes cluster. It is a one-time install that gives you a number of important benefits, including the ability to: |
Also, align this description with the one in the README file of this tutorial
site/content/docs/latest/tutorials/kubeapps-on-tce/introduction.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Intended Audience | ||
|
|
||
| This guide is intended for the following user roles: |
There was a problem hiding this comment.
Suggested change
| This guide is intended for the following user roles: | |
| This guide is intended for the following personas: |
| This guide is intended for the following user roles: | ||
|
|
||
| - System administrators who want to install Kubeapps on a VMware Tanzu™ Community Edition cluster and use it to deploy and manage applications from any package repository. | ||
| - Application administrators and developers who want to use Kubeapps to deploy and manage modern applications in a Kubernetes architecture. |
There was a problem hiding this comment.
Suggested change
| - Application administrators and developers who want to use Kubeapps to deploy and manage modern applications in a Kubernetes architecture. | |
| - Application administrators and developers who want to use Kubeapps to deploy and manage applications in a Kubernetes cluster. |
| 2. [Deploying a managed cluster](./02-TCE-managed-cluster.md) or [Deploy an unmanaged cluster](./02-TCE-unmanaged-cluster.md) | ||
| 3. [Preparing the Kubeapps deployment](./03-preparing-kubeapps-deployment.md) | ||
| 4. [Deploying Kubeapps](./04-deploying-kubeapps.md) | ||
| 5. [Further documentation for managing applications in Kubeapps](./05-Managing-applications.md) |
There was a problem hiding this comment.
Suggested change
| 5. [Further documentation for managing applications in Kubeapps](./05-Managing-applications.md) | |
| 5. [Further documentation for managing applications in Kubeapps](./05-managing-applications.md) |
ppbaena
approved these changes
Jul 14, 2022
|
|
||
| By default, unmanaged clusters run locally via kind (default) or minikube with Tanzu components installed atop. | ||
|
|
||
| ## Spinp up a TCE unmanaged cluster |
There was a problem hiding this comment.
Suggested change
| ## Spinp up a TCE unmanaged cluster | |
| ## Spin up a TCE unmanaged cluster |
site/content/docs/latest/tutorials/kubeapps-on-tce/02-TCE-unmanaged-cluster.md
Show resolved
Hide resolved
Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
…ter-preparation.md Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
…ter-preparation.md Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
…ged-cluster.md Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
…n.md Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
…ged-cluster.md Co-authored-by: Antonio Gámez, PhD <agamez@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
…pps into 4935-kubeapps-TCE-doc Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Signed-off-by: Rafa Castelblanque <rcastelblanq@vmware.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change
This PR adds documentation for guiding users to a scenario with a TCE cluster and Kubeapps running.
It is done in the form of a tutorial that can be seen here.
Benefits
TCE users are onboarded in the Kubeapps installation.
Possible drawbacks
Maybe not detailed enough?
Applicable issues