Skip to content

Docs - #25

Open
foot wants to merge 9 commits into
mainfrom
docs
Open

Docs#25
foot wants to merge 9 commits into
mainfrom
docs

Conversation

@foot

@foot foot commented Nov 24, 2023

Copy link
Copy Markdown
Collaborator
  • Add some user docs
  • Upgrade to helmify 4.10 which includes support for annotating Service Accounts

@foot
foot marked this pull request as ready for review November 24, 2023 13:49

@bigkevmcd bigkevmcd left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great so far!

Comment thread docs/README.md
Comment thread docs/README.md
> [!NOTE]
> AWS uses the term "labels", here we'll use "tags" to refer to both AWS labels and Azure tags.

Any tags you add to your AKS/EKS clusters will be added as labels to the `GitopsCluster` resource. This is useful to tie into other components like the cluster bootstrap controller and the GitOpsSets controller. These controllers use labels to determine which clusters to act upon.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link to docs for these controllers?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that would be neat. Ideally we want to be able to copy these instruction over the public facing site pretty verbatim which makes linking tricky.

Thinking..

Comment thread docs/README.md Outdated
Comment thread docs/README.md Outdated
Comment thread docs/README.md

The steps are roughly:

- Create an IAM Policy that can list EKS clusters and get kubeconfigs.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link to these, provide more detail?

Comment thread docs/README.md

Its often used to run `flux bootstrap` on a new cluster to install flux and connect it to a Git Repository.

EXAMPLE

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep good one

Comment thread docs/README.md

If we tag our AKS/EKS cluster with `wego-admin-rbac: enabled` in the Azure portal or AWS Console, then the Cluster Reflector will create a GitopsCluster with that label.

We can then create a GitOpsSet that will generate a Kustomization for each cluster with the label `wego-admin-rbac: enabled`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tended to mark names of CRs as code so that it's clear that it's a specific thing, so here GitOpsSet and Kustomization.

foot and others added 2 commits December 11, 2023 16:42
Co-authored-by: Kevin McDermott <kevin@weave.works>
Co-authored-by: Kevin McDermott <kevin@weave.works>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants