Skip to content

Commit 54dfd42

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #9112 from sbueringer/pr-fix-doctoc
🐛 Fix doctoc detection in verify-doctoc.sh
2 parents 1567f68 + e12200e commit 54dfd42

38 files changed

+1096
-970
lines changed

‎CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [CLIs](#clis)
1212
- [Branches](#branches)
1313
- [Support and guarantees](#support-and-guarantees)
14+
- [Removal of v1alpha3 & v1alpha4 apiVersions](#removal-of-v1alpha3--v1alpha4-apiversions)
1415
- [Contributing a Patch](#contributing-a-patch)
1516
- [Documentation changes](#documentation-changes)
1617
- [Releases](#releases)

‎Makefile

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,10 @@ generate-modules: ## Run go mod tidy to ensure modules are up to date
503503
cd $(TOOLS_DIR); go mod tidy
504504
cd $(TEST_DIR); go mod tidy
505505

506+
.PHONY: generate-doctoc
507+
generate-doctoc:
508+
TRACE=$(TRACE) ./hack/generate-doctoc.sh
509+
506510
.PHONY: generate-e2e-templates
507511
generate-e2e-templates: $(KUSTOMIZE) $(addprefix generate-e2e-templates-, v1.0 v1.3 v1.4 main) ## Generate cluster templates for all versions
508512

@@ -596,7 +600,7 @@ APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main)
596600
apidiff: $(GO_APIDIFF) ## Check for API differences
597601
$(GO_APIDIFF) $(APIDIFF_OLD_COMMIT) --print-compatible
598602

599-
ALL_VERIFY_CHECKS = doctoc boilerplate shellcheck tiltfile modules gen conversions capi-book-summary
603+
ALL_VERIFY_CHECKS = doctoc boilerplate shellcheck tiltfile modules gen conversions doctoc capi-book-summary
600604

601605
.PHONY: verify
602606
verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) lint-dockerfiles ## Run all verify-* targets
@@ -623,9 +627,11 @@ verify-gen: generate ## Verify go generated files are up to date
623627
verify-conversions: $(CONVERSION_VERIFIER) ## Verifies expected API conversion are in place
624628
$(CONVERSION_VERIFIER)
625629

626-
.PHONY: verify-doctoc
627-
verify-doctoc:
628-
TRACE=$(TRACE) ./hack/verify-doctoc.sh
630+
verify-doctoc: generate-doctoc
631+
@if !(git diff --quiet HEAD); then \
632+
git diff; \
633+
echo "doctoc is out of date, run make generate-doctoc"; exit 1; \
634+
fi
629635

630636
.PHONY: verify-capi-book-summary
631637
verify-capi-book-summary:

‎docs/proposals/20181121-machine-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Minimalistic Machines API
33
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
44
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
55

6-
76
- [Capabilities](#capabilities)
87
- [Proposal](#proposal)
98
- [In-place vs. Replace](#in-place-vs-replace)

‎docs/proposals/20190610-machine-states-preboot-bootstrapping.md

Lines changed: 59 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -18,62 +18,65 @@ status: implemented
1818

1919
## Table of Contents
2020

21-
* [Machine States &amp; Preboot Bootstrapping](#machine-states--preboot-bootstrapping)
22-
* [Table of Contents](#table-of-contents)
23-
* [Glossary](#glossary)
24-
* [Summary](#summary)
25-
* [Motivation](#motivation)
26-
* [Goals](#goals)
27-
* [Non-Goals/Future Work](#non-goalsfuture-work)
28-
* [Proposal](#proposal)
29-
* [Data model changes](#data-model-changes)
30-
* [States and transitions](#states-and-transitions)
31-
* [Pending](#pending)
32-
* [Transition Conditions](#transition-conditions)
33-
* [Expectations](#expectations)
34-
* [Provisioning](#provisioning)
35-
* [Transition Conditions](#transition-conditions-1)
36-
* [Expectations](#expectations-1)
37-
* [Provisioned](#provisioned)
38-
* [Transition Conditions](#transition-conditions-2)
39-
* [Expectations](#expectations-2)
40-
* [Running](#running)
41-
* [Transition Conditions](#transition-conditions-3)
42-
* [Expectations](#expectations-3)
43-
* [Deleting](#deleting)
44-
* [Transition Conditions](#transition-conditions-4)
45-
* [Expectations](#expectations-4)
46-
* [Deleted](#deleted)
47-
* [Transition Conditions](#transition-conditions-5)
48-
* [Expectations](#expectations-5)
49-
* [Failed](#failed)
50-
* [Transition Conditions](#transition-conditions-6)
51-
* [Expectations](#expectations-6)
52-
* [Sequence diagram: User creates a machine with Kubeadm bootstrapper\.](#sequence-diagram-user-creates-a-machine-with-kubeadm-bootstrapper)
53-
* [User Stories](#user-stories)
54-
* [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
55-
* [Machine Controller Role](#machine-controller-role)
56-
* [Machine Controller dynamic watchers](#machine-controller-dynamic-watchers)
57-
* [Object References, Templates, MachineSets and MachineDeployments](#object-references-templates-machinesets-and-machinedeployments)
58-
* [Controllers and the single responsibility approach](#controllers-and-the-single-responsibility-approach)
59-
* [Remote references and accessing a workload cluster](#remote-references-and-accessing-a-workload-cluster)
60-
* [The “Phase” field and its role](#the-phase-field-and-its-role)
61-
* [Showing a status summary to users](#showing-a-status-summary-to-users)
62-
* [Risks and Mitigations](#risks-and-mitigations)
63-
* [State transitions are inflexible](#state-transitions-are-inflexible)
64-
* [Machine Controller can access any machine or cluster in any namespace](#machine-controller-can-access-any-machine-or-cluster-in-any-namespace)
65-
* [Certificates and tokens are exposed in plaintext](#certificates-and-tokens-are-exposed-in-plaintext)
66-
* [Bootstrap data cannot be merged](#bootstrap-data-cannot-be-merged)
67-
* [MachineClass is deprecated and will be revisited later](#machineclass-is-deprecated-and-will-be-revisited-later)
68-
* [Design Details](#design-details)
69-
* [Test Plan](#test-plan)
70-
* [Graduation Criteria](#graduation-criteria)
71-
* [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
72-
* [Version Skew Strategy](#version-skew-strategy)
73-
* [Implementation History](#implementation-history)
74-
* [Drawbacks](#drawbacks)
75-
* [Alternatives](#alternatives)
76-
* [Object References, Templates, MachineSets and MachineDeployments](#object-references-templates-machinesets-and-machinedeployments-1)
21+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
22+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
23+
24+
- [Glossary](#glossary)
25+
- [Summary](#summary)
26+
- [Motivation](#motivation)
27+
- [Goals](#goals)
28+
- [Non-Goals/Future Work](#non-goalsfuture-work)
29+
- [Proposal](#proposal)
30+
- [Data model changes](#data-model-changes)
31+
- [States and transitions](#states-and-transitions)
32+
- [Pending](#pending)
33+
- [Transition Conditions](#transition-conditions)
34+
- [Expectations](#expectations)
35+
- [Provisioning](#provisioning)
36+
- [Transition Conditions](#transition-conditions-1)
37+
- [Expectations](#expectations-1)
38+
- [Provisioned](#provisioned)
39+
- [Transition Conditions](#transition-conditions-2)
40+
- [Expectations](#expectations-2)
41+
- [Running](#running)
42+
- [Transition Conditions](#transition-conditions-3)
43+
- [Expectations](#expectations-3)
44+
- [Deleting](#deleting)
45+
- [Transition Conditions](#transition-conditions-4)
46+
- [Expectations](#expectations-4)
47+
- [Deleted](#deleted)
48+
- [Transition Conditions](#transition-conditions-5)
49+
- [Expectations](#expectations-5)
50+
- [Failed](#failed)
51+
- [Transition Conditions](#transition-conditions-6)
52+
- [Expectations](#expectations-6)
53+
- [Sequence diagram: User creates a machine with Kubeadm bootstrapper.](#sequence-diagram-user-creates-a-machine-with-kubeadm-bootstrapper)
54+
- [User Stories](#user-stories)
55+
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
56+
- [Machine Controller Role](#machine-controller-role)
57+
- [Machine Controller dynamic watchers](#machine-controller-dynamic-watchers)
58+
- [Object References, Templates, MachineSets and MachineDeployments](#object-references-templates-machinesets-and-machinedeployments)
59+
- [Controllers and the single responsibility approach](#controllers-and-the-single-responsibility-approach)
60+
- [Remote references and accessing a workload cluster](#remote-references-and-accessing-a-workload-cluster)
61+
- [The “Phase” field and its role](#the-phase-field-and-its-role)
62+
- [Showing a status summary to users](#showing-a-status-summary-to-users)
63+
- [Risks and Mitigations](#risks-and-mitigations)
64+
- [State transitions are inflexible](#state-transitions-are-inflexible)
65+
- [Machine Controller can access any machine or cluster in any namespace](#machine-controller-can-access-any-machine-or-cluster-in-any-namespace)
66+
- [Certificates and tokens are exposed in plaintext](#certificates-and-tokens-are-exposed-in-plaintext)
67+
- [Bootstrap data cannot be merged](#bootstrap-data-cannot-be-merged)
68+
- [MachineClass is deprecated and will be revisited later](#machineclass-is-deprecated-and-will-be-revisited-later)
69+
- [Design Details](#design-details)
70+
- [Test Plan](#test-plan)
71+
- [Graduation Criteria](#graduation-criteria)
72+
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
73+
- [Version Skew Strategy](#version-skew-strategy)
74+
- [Implementation History](#implementation-history)
75+
- [Drawbacks](#drawbacks)
76+
- [Alternatives](#alternatives)
77+
- [Object References, Templates, MachineSets and MachineDeployments](#object-references-templates-machinesets-and-machinedeployments-1)
78+
79+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7780

7881
## Glossary
7982

‎docs/proposals/20190709-cluster-spec-crds.md

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,44 @@ see-also:
1818

1919
## Table of Contents
2020

21-
* [Cluster Spec &amp; Status CRDs](#cluster-spec--status-crds)
22-
* [Table of Contents](#table-of-contents)
23-
* [Summary](#summary)
24-
* [Motivation](#motivation)
25-
* [Goals](#goals)
26-
* [Non-Goals/Future Work](#non-goalsfuture-work)
27-
* [Proposal](#proposal)
28-
* [Data Model changes](#data-model-changes)
29-
* [Controller collaboration](#controller-collaboration)
30-
* [States and Transitions](#states-and-transitions)
31-
* [Pending](#pending)
32-
* [Conditions](#conditions)
33-
* [Expectations](#expectations)
34-
* [Provisioning](#provisioning)
35-
* [Transition Conditions](#transition-conditions)
36-
* [Expectations](#expectations-1)
37-
* [Provisioned](#provisioned)
38-
* [Transition Conditions](#transition-conditions-1)
39-
* [Expectations](#expectations-2)
40-
* [User Stories](#user-stories)
41-
* [As an infrastructure provider author, I would like to take advantage of the Kubernetes API to provide validation for provider-specific data needed to provision a cluster infrastructure.](#as-an-infrastructure-provider-author-i-would-like-to-take-advantage-of-the-kubernetes-api-to-provide-validation-for-provider-specific-data-needed-to-provision-a-cluster-infrastructure)
42-
* [As an infrastructure provider author, I would like to build a controller to manage provisioning cluster infrastructure using tools of my own choosing.](#as-an-infrastructure-provider-author-i-would-like-to-build-a-controller-to-manage-provisioning-cluster-infrastructure-using-tools-of-my-own-choosing)
43-
* [As an infrastructure provider author, I would like to build a controller to manage provisioning clusters without being restricted to a CRUD API.](#as-an-infrastructure-provider-author-i-would-like-to-build-a-controller-to-manage-provisioning-clusters-without-being-restricted-to-a-crud-api)
44-
* [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
45-
* [Role of Cluster Controller](#role-of-cluster-controller)
46-
* [Cluster Controller dynamic watchers](#cluster-controller-dynamic-watchers)
47-
* [Risks and Mitigations](#risks-and-mitigations)
48-
* [Design Details](#design-details)
49-
* [Test Plan](#test-plan)
50-
* [Graduation Criteria](#graduation-criteria)
51-
* [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
52-
* [Version Skew Strategy](#version-skew-strategy)
53-
* [Implementation History](#implementation-history)
54-
* [Drawbacks [optional]](#drawbacks-optional)
55-
* [Alternatives [optional]](#alternatives-optional)
21+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
22+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
23+
24+
- [Summary](#summary)
25+
- [Motivation](#motivation)
26+
- [Goals](#goals)
27+
- [Non-Goals/Future Work](#non-goalsfuture-work)
28+
- [Proposal](#proposal)
29+
- [Data Model changes](#data-model-changes)
30+
- [Controller collaboration](#controller-collaboration)
31+
- [States and Transitions](#states-and-transitions)
32+
- [Pending](#pending)
33+
- [Conditions](#conditions)
34+
- [Expectations](#expectations)
35+
- [Provisioning](#provisioning)
36+
- [Transition Conditions](#transition-conditions)
37+
- [Expectations](#expectations-1)
38+
- [Provisioned](#provisioned)
39+
- [Transition Conditions](#transition-conditions-1)
40+
- [Expectations](#expectations-2)
41+
- [User Stories](#user-stories)
42+
- [As an infrastructure provider author, I would like to take advantage of the Kubernetes API to provide validation for provider-specific data needed to provision a cluster infrastructure.](#as-an-infrastructure-provider-author-i-would-like-to-take-advantage-of-the-kubernetes-api-to-provide-validation-for-provider-specific-data-needed-to-provision-a-cluster-infrastructure)
43+
- [As an infrastructure provider author, I would like to build a controller to manage provisioning cluster infrastructure using tools of my own choosing.](#as-an-infrastructure-provider-author-i-would-like-to-build-a-controller-to-manage-provisioning-cluster-infrastructure-using-tools-of-my-own-choosing)
44+
- [As an infrastructure provider author, I would like to build a controller to manage provisioning clusters without being restricted to a CRUD API.](#as-an-infrastructure-provider-author-i-would-like-to-build-a-controller-to-manage-provisioning-clusters-without-being-restricted-to-a-crud-api)
45+
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
46+
- [Role of Cluster Controller](#role-of-cluster-controller)
47+
- [Cluster Controller dynamic watchers](#cluster-controller-dynamic-watchers)
48+
- [Risks and Mitigations](#risks-and-mitigations)
49+
- [Design Details](#design-details)
50+
- [Test Plan](#test-plan)
51+
- [Graduation Criteria](#graduation-criteria)
52+
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
53+
- [Version Skew Strategy](#version-skew-strategy)
54+
- [Implementation History](#implementation-history)
55+
- [Drawbacks [optional]](#drawbacks-optional)
56+
- [Alternatives [optional]](#alternatives-optional)
57+
58+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
5659

5760
## Summary
5861

‎docs/proposals/20190919-machinepool-api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
---
22
title: MachinePool API
3+
authors:
4+
- "@juan-lee"
5+
- "@CecileRobertMichon"
6+
reviewers:
7+
- "@detiber"
8+
- "@justaugustus"
9+
- "@ncdc"
10+
- "@vincepri"
11+
creation-date: 2019-09-19
12+
last-updated: 2019-11-24
13+
replaces:
14+
- [cluster-api-provider-azure Proposal](https://docs.google.com/document/d/1nbOqCIC0-ezdMXubZIV6EQrzD0QYPrpcdCBB4oSjWeQ/edit)
15+
status: provisional
16+
---
17+
318
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
419
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
520

6-
721
- [MachinePool API](#machinepool-api)
822
- [Glossary](#glossary)
923
- [Summary](#summary)
@@ -51,20 +65,6 @@ title: MachinePool API
5165

5266
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
5367

54-
authors:
55-
- "@juan-lee"
56-
- "@CecileRobertMichon"
57-
reviewers:
58-
- "@detiber"
59-
- "@justaugustus"
60-
- "@ncdc"
61-
- "@vincepri"
62-
creation-date: 2019-09-19
63-
last-updated: 2019-11-24
64-
replaces:
65-
- [cluster-api-provider-azure Proposal](https://docs.google.com/document/d/1nbOqCIC0-ezdMXubZIV6EQrzD0QYPrpcdCBB4oSjWeQ/edit)
66-
status: provisional
67-
---
6868

6969
# MachinePool API
7070

‎docs/proposals/20191016-clusterctl-redesign.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,34 @@ status: implementable
2121

2222
## Table of Contents
2323

24-
- [Table of Contents](#table-of-contents)
24+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
25+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
26+
2527
- [Glossary](#glossary)
2628
- [Summary](#summary)
2729
- [Motivation](#motivation)
28-
- [Goals](#goals)
29-
- [Non-Goals/Future Work](#non-goalsfuture-work)
30+
- [Goals](#goals)
31+
- [Non-Goals/Future Work](#non-goalsfuture-work)
3032
- [Proposal](#proposal)
31-
- [Preconditions](#preconditions)
32-
- [User Stories](#user-stories)
33-
- [Initial Deployment](#initial-deployment)
34-
- [Day Two Operations “Lifecycle Management”](#day-two-operations-lifecycle-management)
35-
- [Target Cluster Pivot Management](#target-cluster-pivot-management)
36-
- [Provider Enablement](#provider-enablement)
37-
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
38-
- [Init sequence](#init-sequence)
39-
- [Day 2 operations](#day-2-operations)
40-
- [Risks and Mitigations](#risks-and-mitigations)
33+
- [Preconditions](#preconditions)
34+
- [User Stories](#user-stories)
35+
- [Initial Deployment](#initial-deployment)
36+
- [Day Two Operations “Lifecycle Management”](#day-two-operations-lifecycle-management)
37+
- [Target Cluster Pivot Management](#target-cluster-pivot-management)
38+
- [Provider Enablement](#provider-enablement)
39+
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
40+
- [Init sequence](#init-sequence)
41+
- [Day 2 operations](#day-2-operations)
42+
- [Risks and Mitigations](#risks-and-mitigations)
4143
- [Upgrade Strategy](#upgrade-strategy)
4244
- [Additional Details](#additional-details)
43-
- [Test Plan [optional]](#test-plan-optional)
44-
- [Graduation Criteria [optional]](#graduation-criteria-optional)
45-
- [Version Skew Strategy](#version-skew-strategy)
45+
- [Test Plan [optional]](#test-plan-optional)
46+
- [Graduation Criteria [optional]](#graduation-criteria-optional)
47+
- [Version Skew Strategy](#version-skew-strategy)
4648
- [Implementation History](#implementation-history)
4749

50+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
51+
4852
## Glossary
4953

5054
Refer to the [Cluster API Book Glossary](https://cluster-api.sigs.k8s.io/reference/glossary.html).

‎docs/proposals/20191016-e2e-test-framework.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ superseded-by: []
2727
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2828
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2929

30-
3130
- [Glossary](#glossary)
3231
- [Summary](#summary)
3332
- [Motivation](#motivation)

0 commit comments

Comments
 (0)