📖 Assorted docs updates #1318

moshloop · 2019-08-25T18:10:33Z

/assign @ncdc @chuckha

docs/book/getting_started/interoperability.md

vincepri · 2019-08-27T18:53:32Z

@moshloop Are you able to address the comments above before tomorrow's meeting?

moshloop · 2019-08-27T20:39:02Z

@vincepri will do

detiber · 2019-08-28T13:30:35Z

docs/book/getting_started/interoperability.md

+
+Cluster API expects certificates and keys used for bootstrapping to follow the below convention. CAPBK generates new certificates using this convention if they do not already exist.
+
+* Each certificate must be stored PEM encoded in a single secret named one of:


Suggested change

* Each certificate must be stored PEM encoded in a single secret named one of:

* Each certificate authority keypair must be stored individually in a secret with a name that reflects the cluster and it's use:

detiber · 2019-08-28T13:31:51Z

docs/book/getting_started/interoperability.md

+    * `<cluster name>-ca`
+    * `<cluster name>-etcd`
+    * `<cluster name>-proxy`
+    * `<cluster name>-sa`


I think it would be good to call out the <cluster name>-sa separately since it is not a CA, but rather just a public/private keypair.

i'd go into more detail about the contents of these Secrets and their purpose.

One thing that just crossed my mind, is that outside of <cluster-name>-ca and a generated <cluster-name>-kubeconfig, the other values listed here are particular to the kubeadm bootstrapper, maybe we should not define the interoperability of those values here, but rather on the kubeadm bootstrapper?

docs/book/getting_started/interoperability.md

detiber · 2019-08-28T13:35:36Z

docs/book/getting_started/interoperability.md

+    * `<cluster name>-sa`
+* Each secret must have the following label:
+  * `cluster.x-k8s.io/cluster-name=<cluster name>`
+* Secrets must be of type TLS with 2 values `tls.crt` and `tls.key`


Suggested change

* Secrets must be of type TLS with 2 values `tls.crt` and `tls.key`

* Secrets must be of type TLS with 2 keys `tls.crt` and `tls.key`, where the value of each is the PEM encoded public (`tls.crt`) or private ('tls.key`) key.

detiber · 2019-08-28T13:40:38Z

docs/book/getting_started/interoperability.md

+    cluster.x-k8s.io/cluster-name: cluster1
+type: kubernetes.io/tls
+data:
+  tls.crt: ICAgIC0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLQogICAgTUlJQ3l6Q0NBYk9nQXdJQkFnSUJBREFOQmdrcWhraUc5dzBCQVFzRkFEQVZNUk13RVFZRFZRUURFd3ByZFdKbAogICAgY201bGRHVnpNQjRYRFRFNU1EZ3lNekV3TURRek1Gb1hEVEk1TURneU1ERXdNRFF6TUZvd0ZURVRNQkVHQTFVRQogICAgQXhNS2EzVmlaWEp1WlhSbGN6Q0NBU0l3RFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURDQ0FRb0NnZ0VCQU1oZgogICAgV0lxdGUzMFRkNXlXM1hQWCs5SDV5S3I1N0NoNDJ2Y3o4cU9DdXFZazZMeWpBcG1hS3FyaTcwRTJ1ZVlYQ0U4RAogICAgMVAwaVRlOXd5L2M0VFpNcmFwUHBHNHo5UDF3bCtTdG5WcTVBZWV6aU9IY1BIcERyNVR4VGViUllnR3dmUFlLdwogICAgdm5kS0JseXYzQXhVR0NIU2hOV01hSUx0dko0RktKZ0NGNXVVUjE3SExsMnVyQ1dmNTBpNmEwK3pLcHZLejZYVwogICAgUmlGTWxZalhlUHFrKzB2QjdWcGxla05JTnFEbm9IRk1kZFBudXZjUW5NSTU1Q2NadHd5S09HMHp0OXBPYXdJYwogICAga3B5a0xSb20rWlBpQ3AzdG1BMnRBUHRsQmJTcmMvZmtVN1BUS2VacjduZ05RYnJocTFudlR3KzFYcmRwcG5qdQogICAgVTB6QVZ2N1JKOS9JSEJTdEFIY0NBd0VBQWFNbU1DUXdEZ1lEVlIwUEFRSC9CQVFEQWdLa01CSUdBMVVkRXdFQgogICAgL3dRSU1BWUJBZjhDQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFKOUFUT01STC9hdnJGMWZ4N21xaDFFUwogICAgQ3JjcmZIQVFvWlhaTEhXV2lqVm56VGQvYmFKUTZhL0haejMvTm1TemxtK255cW1vWUNqODZmWENDUTdqLzdLbQogICAgMnk3YzhrVWwxSjFQMWtiNGpkWmhlQS9aa1ZWUHVpSHlRNU1CM3dVWEtDQTdudWtLem04blRKRUFWSXE0azEzdwogICAgL1MwYVZaM1JPVWpvSGxhcWl0L1NHdzZSVm9KQTVWb2p5Unh2VEIxdDFyL3JqajlFa0JLVkVHM3pQNGJacC8rcAogICAgdTdYWDluc0xRUWR5YVZSazU4N29vWXpDMTdOQys3OFJub1JoR2tXbUlZTmZWaUllSGVmNU9ac2UxZ0VPRXVOQQogICAgVW9WanlsRkJSbk9XL1pTVEN5bEhGU3M3Z0kvakV1cmVzbWtNdFYzTThxWG5LN2JaRG9rNzZpRGU1RDZlYUNzPQogICAgLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==


If we want to enforce PEM encoding that we would need to include the BEGIN and END headers here.

I wasn't able to find anything in the cert-manager docs related to how it encodes the secrets it generates, is there any guarantees they make related to the Secrets they generate?

This is BASE64 encoded PEM

The PEM format requires the BEGIN and END markers: https://tools.ietf.org/html/rfc7468

fwiw, I'm not saying we should require PEM format, I'm just saying that we should accurately represent the format we are expecting/using.

ncdc · 2019-09-11T14:56:57Z

@moshloop Hi! Will you have some time soon to pick this back up?

vincepri · 2019-09-11T14:57:54Z

If it's possible, it'd be great to move this page under the developer guide of the new book

moshloop · 2019-09-11T15:10:56Z

I will have this done before the F2F next week.

vincepri · 2019-09-23T14:55:13Z

@moshloop Do you have time this week to get this document to the book?

moshloop · 2019-09-23T15:18:15Z

Yes, working on it as we speak, going to include it in a larger docs PR in the next day or 2

vincepri · 2019-09-23T15:25:21Z

Thanks!

k8s-ci-robot · 2019-09-24T06:38:31Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

moshloop · 2019-10-01T18:53:39Z

ping @ncdc @vincepri @detiber

vincepri · 2019-10-01T18:54:14Z

@moshloop Seems there are some conflicts that need to be resolved

vincepri · 2019-10-01T18:57:38Z

@moshloop I'm not sure what happened to the docs, but it seems the changes in this PR aren't based on the latest version of the book, which is published here https://cluster-api.sigs.k8s.io.

The scope of this PR has grown too much imo, and I want to ask if you have time to either split the commits or preferably to open different PRs so it's easier to review.

/hold

vincepri · 2019-10-01T18:54:50Z

docs/book/SUMMARY.md

@@ -0,0 +1,32 @@
+# Managing Kubernetes Infrastructure with the Cluster API


This file seems extra

vincepri · 2019-10-01T18:55:23Z

docs/book/src/architecture/controllers/cluster.md

@@ -1 +1,3 @@
 # Cluster
+<!-- TODO -->
+![](../../images/cluster-admission-cluster-controller.svg)


The image linked seems to be missing?

vincepri · 2019-10-01T18:58:27Z

docs/book/src/user/installing.md

@@ -0,0 +1,119 @@
+# Installation


This is the quick start and shouldn't be renamed. There are multiple links to it in the wild

vincepri · 2019-10-01T19:22:51Z

docs/book/src/SUMMARY.md

@@ -2,13 +2,16 @@

 [Introduction](./introduction.md)

+- [Quick Start](./user/quick-start.md)


Suggested change

- [Quick Start](./user/quick-start.md)

[Quick Start](./user/quick-start.md)

k8s-ci-robot · 2019-10-10T17:42:38Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

* Copied over some concepts from glossary * Added certificate management page * Move abbreviations into glossary * Added bootstrap controller * Coped some diagrams from CAPV into controller pages * Created standalone installation page * Moved quick start up a level * Moved clusterctl to references as per docs.k8s.io

moshloop · 2019-10-10T17:51:00Z

@vincepri @randomvariable @ncdc

Deployed to https://book-789v67wdn.now.sh/ for easy review

vincepri

Thanks for finishing this up!

/lgtm

vincepri · 2019-10-10T18:36:20Z

/approve

k8s-ci-robot · 2019-10-10T18:36:26Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: moshloop, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot assigned chuckha and ncdc Aug 25, 2019

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 25, 2019

k8s-ci-robot requested review from detiber and ncdc August 25, 2019 18:10

ncdc reviewed Aug 26, 2019

View reviewed changes

docs/book/getting_started/interoperability.md Outdated Show resolved Hide resolved

vincepri reviewed Aug 26, 2019

View reviewed changes

docs/book/getting_started/interoperability.md Outdated Show resolved Hide resolved

docs/book/getting_started/interoperability.md Outdated Show resolved Hide resolved

vincepri mentioned this pull request Aug 27, 2019

Cluster Controller should create kubeconfig Secret for remote clusters #1274

Closed

moshloop force-pushed the master branch from 5253c8b to 4332ed8 Compare August 28, 2019 07:33

detiber reviewed Aug 28, 2019

View reviewed changes

detiber modified the milestones: v0.2.0 (v1alpha2), v0.2.x (v1alpha2) Aug 29, 2019

vincepri mentioned this pull request Aug 29, 2019

⚠️ Add certificate and secret utils #1342

Merged

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 24, 2019

moshloop force-pushed the master branch from bbe74c2 to da31ee8 Compare September 24, 2019 06:46

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 24, 2019

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2019

vincepri reviewed Oct 1, 2019

View reviewed changes

moshloop force-pushed the master branch from 6ae2aa2 to 323f7e6 Compare October 10, 2019 17:42

k8s-ci-robot removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 10, 2019

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 10, 2019

moshloop force-pushed the master branch from 323f7e6 to ff3357d Compare October 10, 2019 17:49

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 10, 2019

vincepri approved these changes Oct 10, 2019

View reviewed changes

k8s-ci-robot assigned vincepri Oct 10, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 10, 2019

vincepri removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 10, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 10, 2019

k8s-ci-robot merged commit 651d7ce into kubernetes-sigs:master Oct 10, 2019

dlipovetsky mentioned this pull request Oct 14, 2019

docs: Add quick start for the Docker provider #1484

Merged

chymy mentioned this pull request Mar 16, 2021

📖 Fix figure 1 not found #4327

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 Assorted docs updates #1318

📖 Assorted docs updates #1318

moshloop commented Aug 25, 2019

vincepri commented Aug 27, 2019

moshloop commented Aug 27, 2019

detiber Aug 28, 2019

detiber Aug 28, 2019

neolit123 Aug 29, 2019

detiber Aug 29, 2019

detiber Aug 28, 2019

detiber Aug 28, 2019

moshloop Aug 28, 2019

detiber Aug 28, 2019

detiber Aug 28, 2019

ncdc commented Sep 11, 2019

vincepri commented Sep 11, 2019

moshloop commented Sep 11, 2019

vincepri commented Sep 23, 2019 •

edited

Loading

moshloop commented Sep 23, 2019

vincepri commented Sep 23, 2019

k8s-ci-robot commented Sep 24, 2019

moshloop commented Oct 1, 2019

vincepri commented Oct 1, 2019

vincepri commented Oct 1, 2019

vincepri Oct 1, 2019

vincepri Oct 1, 2019

vincepri Oct 1, 2019

vincepri Oct 1, 2019

k8s-ci-robot commented Oct 10, 2019

moshloop commented Oct 10, 2019

vincepri left a comment

vincepri commented Oct 10, 2019

k8s-ci-robot commented Oct 10, 2019


		Cluster API expects certificates and keys used for bootstrapping to follow the below convention. CAPBK generates new certificates using this convention if they do not already exist.

		* Each certificate must be stored PEM encoded in a single secret named one of:

	* Each certificate must be stored PEM encoded in a single secret named one of:
	* Each certificate authority keypair must be stored individually in a secret with a name that reflects the cluster and it's use:

	* Secrets must be of type TLS with 2 values `tls.crt` and `tls.key`
	* Secrets must be of type TLS with 2 keys `tls.crt` and `tls.key`, where the value of each is the PEM encoded public (`tls.crt`) or private ('tls.key`) key.

		@@ -0,0 +1,32 @@
		# Managing Kubernetes Infrastructure with the Cluster API

		@@ -2,13 +2,16 @@

		[Introduction](./introduction.md)

		- [Quick Start](./user/quick-start.md)

	- [Quick Start](./user/quick-start.md)
	[Quick Start](./user/quick-start.md)

📖 Assorted docs updates #1318

📖 Assorted docs updates #1318

Conversation

moshloop commented Aug 25, 2019

vincepri commented Aug 27, 2019

moshloop commented Aug 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ncdc commented Sep 11, 2019

vincepri commented Sep 11, 2019

moshloop commented Sep 11, 2019

vincepri commented Sep 23, 2019 • edited Loading

moshloop commented Sep 23, 2019

vincepri commented Sep 23, 2019

k8s-ci-robot commented Sep 24, 2019

moshloop commented Oct 1, 2019

vincepri commented Oct 1, 2019

vincepri commented Oct 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 10, 2019

moshloop commented Oct 10, 2019

vincepri left a comment

Choose a reason for hiding this comment

vincepri commented Oct 10, 2019

k8s-ci-robot commented Oct 10, 2019

vincepri commented Sep 23, 2019 •

edited

Loading