-
Notifications
You must be signed in to change notification settings - Fork 20
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 prerequisites, adjust quick start installation & add architecture diagram #38
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## Requirements | ||
|
||
Project 2A requires a Kubernetes cluster. It can be of any type and will serve as the 2A _management cluster_. | ||
|
||
If you don't yet have a Kubernetes cluster, consider using [k0s](https://docs.k0sproject.io/stable/install/). | ||
|
||
The following instructions assume: | ||
|
||
- Your `kubeconfig` points to the correct Kubernetes cluster. | ||
- You have [Helm](https://helm.sh/docs/intro/install/) installed. | ||
- You have [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) installed. | ||
|
||
Comment on lines
+1
to
+12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure I'm a big fan of moving the requirements away from the Quickstart, this will require a first time user to go through 3 pages of documentation to have a cluster up and running (PreRequisites, General Quickstart and Infra specific Quickstart). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, sure. I can pull the latest and work your feedback in. |
||
### Prerequisites | ||
|
||
Before starting, make sure to meet the following prerequisites for compatibility with Project 2A components: | ||
|
||
1. Kubernetes Version: | ||
- The minimum supported Kubernetes version for Project 2A is 1.28.0. | ||
- Using an older version (e.g., v1.26.2) will cause issues with some components, such as Flux, which require at least v1.28.0. | ||
- For best results, confirm your cluster is running Kubernetes v1.28.0 or later. | ||
|
||
2. Cert-Manager Configuration: | ||
|
||
When installing the Helm chart, note that cert-manager will be installed automatically. | ||
- If cert-manager already exists in your cluster, the installation may fail due to conflicting metadata labels and annotations. | ||
To prevent this, ensure the existing cert-manager resources have the necessary metadata labels and annotations: | ||
- Labels: app.kubernetes.io/managed-by set to "Helm" | ||
- Annotations: | ||
- meta.helm.sh/release-name set to "hmc" | ||
- meta.helm.sh/release-namespace set to "hmc-system" | ||
- Adjusting this metadata should allow for compatibility with the installation. | ||
|
||
### Helpful Tools | ||
|
||
It is helpful to have the following tools installed: | ||
|
||
- [clusterctl](https://cluster-api.sigs.k8s.io/user/quick-start.html?highlight=clusterctl#install-clusterctl) is the CLI for talking to ClusterAPI directly. | ||
- [Mirantis Lens](https://k8slens.dev/) or [k9s](https://k9scli.io/) can be used for simplified management of Kubernetes objects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you provide the source of this? so we can update it whenever needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In which format would you like the diagram? I can export it EPS or SVG. I've created it via Sketch. So, can be a sketch document as well.
Where is there best place to save the source?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say also in the assets folder were the PNG lies
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In which format would you like the diagram? Only PNG?