Add Management Cluster page with details on cluster updates #823

rossf7 · 2021-02-16T18:02:19Z

Towards https://github.com/giantswarm/giantswarm/issues/15700

Please remember to

Give the PR a meaningful title -- it will be shown in the release notes
Add (or remove) user questions associated with any updated docs

rossf7 · 2021-02-16T18:03:43Z

src/content/general/management-clusters/index.md

+
+## Overview of Management Clusters
+
+As we are fully convinced of Kubernetes as a platform for building platforms, we build all our management clusters based on Kubernetes. Giant Swarm leverages the concept of [“Operators"](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to control all resources that clusters need as [“Custom Resources”](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).


This is taken from the architecture docs but I think it works as an intro.

rossf7 · 2021-02-16T18:04:29Z

src/content/general/management-clusters/index.md

+Our workload clusters are versioned using Giant Swarm releases. From a workload cluster point of view upgrades are described in [cluster upgrades]({{< relref "/general/cluster-upgrades" > }}).
+
+For management clusters when we publish a new Giant Swarm release we create a new Release custom resource and any new operator versions are deployed to the management cluster.
+We deploy new instances of the operators with the new version to avoid impacting existing workload clusters. These new operators will not become active until existing workload clusters are upgraded or a new workload cluster is created.


This to me is the key point. As its how we isolate MC updates from workload clusters.

src/content/general/management-clusters/index.md

rossf7 · 2021-02-16T18:06:24Z

src/content/general/management-clusters/index.md

+
+The components that are not part of a Giant Swarm release like our monitoring stack are deployed via app collections. We run the latest version of each component and the collection is managed by our legacy deployment component called draughtsman.
+
+The components are deployed as App custom resources using our app platform. Changes are tested in a number of internal management clusters before being deployed to all management clusters.


I think its best to be explicit here about the test process for MC changes but shout if that isn't helpful / needed.

Further above, App Platform has been title case. Please adjust for consistency.

src/content/general/management-clusters/index.md

rossf7 · 2021-02-16T18:09:42Z

src/content/general/management-clusters/index.md

+
+## Management Cluster infrastructure upgrades
+
+TBC


Do we need to mention Terraform updates here?

If so I think these security docs explain it well. https://docs.giantswarm.io/security/operational-layers/

i think we do, even if we're planning on moving to using operators in future

maybe it's helpful to have a point towards that

I've added it and included why we want to move to Operators and how they are better than Terraform and Kops.

@teemow I took ideas from https://www.giantswarm.io/management-cluster for that. Thanks I hadn't seen that page.

rossf7 · 2021-02-17T10:24:54Z

src/content/general/management-clusters/index.md

+Our workload clusters are versioned using Giant Swarm releases. From a workload cluster point of view upgrades are described in [cluster upgrades]({{< relref "/general/cluster-upgrades" >}}).
+
+For management clusters when we publish a new Giant Swarm release we create a new Release custom resource and any new operator versions are deployed to the management cluster.
+We deploy new instances of the operators with the new version to avoid impacting existing workload clusters. These new operators will not become active until existing workload clusters are upgraded or a new cluster is created.


This to me is the key point. As its how we isolate MC updates from workload clusters.

This looks right to me

rossf7 · 2021-02-17T10:27:59Z

@JosephSalisbury This is what there is so far.

On the 2 TBC sections I'd love your feedback on if they are needed. If so I can continue or feel free to take over if you prefer. Thx!

stone-z

LGTM, just some assorted nitpick suggestions

src/content/general/management-clusters/index.md

Co-authored-by: Zach Stone <zach@giantswarm.io>

src/content/general/management-clusters/index.md

Co-authored-by: Marian Steinbach <marian@giantswarm.io>

rossf7

@stone-z @marians Thanks for the reviews. All changes made.

src/content/general/management-clusters/index.md

Oshratn

I added a few nitpicks. Apart from that is clear and informative.

src/content/general/management-clusters/index.md

Oshratn · 2021-02-18T07:07:15Z

src/content/general/management-clusters/index.md

+
+Our workload clusters are versioned using [workload cluster releases]({{< relref "/general/releases" >}}). From a workload cluster point of view, upgrades are described in [cluster upgrades]({{< relref "/general/cluster-upgrades" >}}).
+
+When we publish a new Giant Swarm release, we create a new Release custom resource and any new operator versions are deployed to the management cluster.


Suggested change

When we publish a new Giant Swarm release, we create a new Release custom resource and any new operator versions are deployed to the management cluster.

When we publish a new Giant Swarm release, we create a new release custom resource and any new operator versions are deployed to the management cluster.

src/content/general/management-clusters/index.md

rossf7 · 2021-02-18T09:05:29Z

OK this should be close now.

Fishing for any final comments or approvals. Otherwise will merge later this morning.

rossf7 · 2021-02-18T10:58:25Z

Going with this. Thanks for all the help <3

Happy to do a follow up if there is feedback that misses the train.

Add docs for management cluster updates

a1a9c89

rossf7 self-assigned this Feb 16, 2021

rossf7 commented Feb 16, 2021

View reviewed changes

Fix CI and minor text change

dafe7cc

rossf7 commented Feb 17, 2021

View reviewed changes

rossf7 requested a review from JosephSalisbury February 17, 2021 10:25

Add missing sections and address review comments

94cd528

rossf7 changed the title ~~Add docs for management cluster updates~~ Add Management Cluster page with details on cluster updates Feb 17, 2021

rossf7 added 2 commits February 17, 2021 15:31

whitespace

58c97dd

Merge branch 'master' into mgmt-cluster-updates

8cca355

rossf7 marked this pull request as ready for review February 17, 2021 14:43

rossf7 requested review from a team, othylmann, puja108 and teemow February 17, 2021 14:44

stone-z approved these changes Feb 17, 2021

View reviewed changes

Apply suggestions from code review

a68a515

Co-authored-by: Zach Stone <zach@giantswarm.io>

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

rossf7 added 2 commits February 17, 2021 18:45

Make support last in general list

e0b86b5

Address review comments

c780ded

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

marians reviewed Feb 17, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

rossf7 and others added 2 commits February 17, 2021 18:51

Apply suggestions from code review

bf68572

Co-authored-by: Marian Steinbach <marian@giantswarm.io>

Make operators lower case

e5abed8

rossf7 commented Feb 17, 2021

View reviewed changes

Oshratn reviewed Feb 18, 2021

View reviewed changes

src/content/general/management-clusters/index.md Outdated Show resolved Hide resolved

Oshratn approved these changes Feb 18, 2021

View reviewed changes

rossf7 added 2 commits February 18, 2021 09:58

Address review comments

faa8638

Merge branch 'master' into mgmt-cluster-updates

2975ebf

Merge branch 'master' into mgmt-cluster-updates

55093b0

rossf7 merged commit 5e54925 into master Feb 18, 2021

rossf7 deleted the mgmt-cluster-updates branch February 18, 2021 10:58


		## Overview of Management Clusters

		As we are fully convinced of Kubernetes as a platform for building platforms, we build all our management clusters based on Kubernetes. Giant Swarm leverages the concept of [“Operators"](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to control all resources that clusters need as [“Custom Resources”](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).


		The components that are not part of a Giant Swarm release like our monitoring stack are deployed via app collections. We run the latest version of each component and the collection is managed by our legacy deployment component called draughtsman.

		The components are deployed as App custom resources using our app platform. Changes are tested in a number of internal management clusters before being deployed to all management clusters.


		Our workload clusters are versioned using [workload cluster releases]({{< relref "/general/releases" >}}). From a workload cluster point of view, upgrades are described in [cluster upgrades]({{< relref "/general/cluster-upgrades" >}}).

		When we publish a new Giant Swarm release, we create a new Release custom resource and any new operator versions are deployed to the management cluster.

Add Management Cluster page with details on cluster updates #823

Add Management Cluster page with details on cluster updates #823

Uh oh!

Conversation

rossf7 commented Feb 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please remember to

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rossf7 commented Feb 17, 2021

Uh oh!

stone-z left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rossf7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Oshratn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rossf7 commented Feb 18, 2021

Uh oh!

rossf7 commented Feb 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rossf7 commented Feb 16, 2021 •

edited

Loading