Skip to content

Commit 70b1852

Browse files
sbueringersbueringer
committed
Fix broken links
Signed-off-by: Stefan Büringer [email protected]
1 parent 22822e7 commit 70b1852

File tree

9 files changed

+97
-105
lines changed

9 files changed

+97
-105
lines changed

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ releases to fix CVEs and critical bugs if needed.
5959

6060
## Dependency Licence Management
6161

62-
Cluster API provider vSphere follows the [license policy of the CNCF](https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md). This sets limits on which
62+
Cluster API provider vSphere follows the [license policy of the CNCF](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md). This sets limits on which
6363
licenses dependencies and other artifacts use. For go dependencies only dependencies listed in the `go.mod` are considered dependencies. This is in line with [how dependencies are reviewed in Kubernetes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md#reviewing-and-approving-dependency-changes).
6464

6565
### Contributor Ladder

‎docs/development.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Using Tilt for rapid iteration
44

5-
Follow the instructions to use [Tilt with Cluster API](https://cluster-api.sigs.k8s.io/developer/tilt.html)
5+
Follow the instructions to use [Tilt with Cluster API](https://cluster-api.sigs.k8s.io/developer/core/tilt.html)
66

77
For example, given a directory layout of
88

‎docs/proposal/20211006-supervisor-based-apis.md‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,22 @@ status: implementable
1313

1414
## Table of Contents
1515

16-
- [Title](#title)
17-
- [Table of Contents](#table-of-contents)
18-
- [Glossary](#glossary)
19-
- [Summary](#summary)
20-
- [Motivation](#motivation)
21-
- [Goals](#goals)
22-
- [Non-Goals/Future Work](#non-goalsfuture-work)
23-
- [Proposal](#proposal)
24-
- [User Stories](#user-stories)
25-
- [Story 1](#story-1)
26-
- [Story 2](#story-2)
27-
- [Story 3](#story-3)
28-
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
29-
- [Security Model](#security-model)
30-
- [Risks and Mitigations](#risks-and-mitigations)
31-
- [Alternatives](#alternatives)
32-
- [Upgrade Strategy](#upgrade-strategy)
33-
- [Implementation History](#implementation-history)
16+
- [Glossary](#glossary)
17+
- [Summary](#summary)
18+
- [Motivation](#motivation)
19+
- [Goals](#goals)
20+
- [Non-Goals/Future Work](#non-goalsfuture-work)
21+
- [Proposal](#proposal)
22+
- [User Stories](#user-stories)
23+
- [Story 1](#story-1)
24+
- [Story 2](#story-2)
25+
- [Story 3](#story-3)
26+
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
27+
- [Security Model](#security-model)
28+
- [Risks and Mitigations](#risks-and-mitigations)
29+
- [Alternatives](#alternatives)
30+
- [Upgrade Strategy](#upgrade-strategy)
31+
- [Implementation History](#implementation-history)
3432

3533
## Glossary
3634

‎docs/proposal/20220907-node-affinity-and-anti-affinity.md‎

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,33 @@ status: proposed
1515

1616
## Table of Contents
1717

18-
* [Support for Node affinity and anti-affinity](#support-for-node-affinity-and-anti-affinity)
19-
* [Table of Contents](#table-of-contents)
20-
* [Glossary](#glossary)
21-
* [Summary](#summary)
22-
* [Motivation](#motivation)
23-
* [Goals](#goals)
24-
* [Future Work](#future-work)
25-
* [Non-Goals](#non-goals)
26-
* [Proposal](#proposal)
27-
* [User Stories](#user-stories)
28-
* [Story 1](#story-1)
29-
* [Story 2](#story-2)
30-
* [Story 3](#story-3)
31-
* [Requirements](#requirements)
32-
* [Functional Requirements](#functional-requirements)
33-
* [Non-Functional Requirements](#non-functional-requirements)
34-
* [Overall Design](#overall-design)
35-
* [Cluster Modules](#cluster-modules)
36-
* [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
37-
* [API changes](#api-changes)
38-
* [VSphereCluster CR](#vspherecluster-cr)
39-
* [VSphereVM CR](#vspherevm-cr)
40-
* [Implementation Details](#implementation-details)
41-
* [VSphereCluster controller changes](#vspherecluster-controller-changes)
42-
* [VSphereVM controller changes](#vspherevm-controller-changes)
43-
* [VSphereMachine controller changes](#vspheremachine-controller-changes)
44-
* [Node label controller changes](#node-label-controller-changes)
45-
* [Feature flags](#feature-flags)
46-
* [Upgrade Strategy](#upgrade-strategy)
18+
* [Glossary](#glossary)
19+
* [Summary](#summary)
20+
* [Motivation](#motivation)
21+
* [Goals](#goals)
22+
* [Future Work](#future-work)
23+
* [Non-Goals](#non-goals)
24+
* [Proposal](#proposal)
25+
* [User Stories](#user-stories)
26+
* [Story 1](#story-1)
27+
* [Story 2](#story-2)
28+
* [Story 3](#story-3)
29+
* [Requirements](#requirements)
30+
* [Functional Requirements](#functional-requirements)
31+
* [Non-Functional Requirements](#non-functional-requirements)
32+
* [Overall Design](#overall-design)
33+
* [Cluster Modules](#cluster-modules)
34+
* [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
35+
* [API changes](#api-changes)
36+
* [VSphereCluster CR](#vspherecluster-cr)
37+
* [VSphereVM CR](#vspherevm-cr)
38+
* [Implementation Details](#implementation-details)
39+
* [VSphereCluster controller changes](#vspherecluster-controller-changes)
40+
* [VSphereVM controller changes](#vspherevm-controller-changes)
41+
* [VSphereMachine controller changes](#vspheremachine-controller-changes)
42+
* [Node label controller changes](#node-label-controller-changes)
43+
* [Feature flags](#feature-flags)
44+
* [Upgrade Strategy](#upgrade-strategy)
4745

4846
## Glossary
4947

‎docs/proposal/20220929-ipam-support.md‎

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,33 @@ status: Implementable
2121

2222
## Table of Contents
2323

24-
- [CAPV IPAM Support](#capv-ipam-support)
25-
- [Table of Contents](#table-of-contents)
26-
- [Glossary](#glossary)
27-
- [Summary](#summary)
28-
- [Motivation](#motivation)
29-
- [Goals](#goals)
30-
- [Non-Goals/Future Work](#non-goalsfuture-work)
31-
- [Proposal](#proposal)
32-
- [User Stories](#user-stories)
33-
- [Story 1](#story-1)
34-
- [Story 2](#story-2)
35-
- [Story 3](#story-3)
36-
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
37-
- [API Changes](#api-changes)
38-
- [VSphereVM Controller Changes](#vspherevm-controller-changes)
39-
- [Owner Reference and Finalizer](#owner-reference-and-finalizer)
40-
- [Flavors](#flavors)
41-
- [Validation](#validation)
42-
- [Nameservers](#nameservers)
43-
- [Security Model](#security-model)
44-
- [Risks and Mitigations](#risks-and-mitigations)
45-
- [Alternatives](#alternatives)
46-
- [Upgrade Strategy](#upgrade-strategy)
47-
- [Additional Details](#additional-details)
48-
- [Test Plan](#test-plan)
49-
- [Graduation Criteria](#graduation-criteria)
50-
- [Version Skew Strategy](#version-skew-strategy)
51-
- [References](#references)
52-
- [Implementation History](#implementation-history)
24+
- [Glossary](#glossary)
25+
- [Summary](#summary)
26+
- [Motivation](#motivation)
27+
- [Goals](#goals)
28+
- [Non-Goals/Future Work](#non-goalsfuture-work)
29+
- [Proposal](#proposal)
30+
- [User Stories](#user-stories)
31+
- [Story 1](#story-1)
32+
- [Story 2](#story-2)
33+
- [Story 3](#story-3)
34+
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
35+
- [API Changes](#api-changes)
36+
- [VSphereVM Controller Changes](#vspherevm-controller-changes)
37+
- [Owner Reference and Finalizer](#owner-reference-and-finalizer)
38+
- [Flavors](#flavors)
39+
- [Validation](#validation)
40+
- [Nameservers](#nameservers)
41+
- [Security Model](#security-model)
42+
- [Risks and Mitigations](#risks-and-mitigations)
43+
- [Alternatives](#alternatives)
44+
- [Upgrade Strategy](#upgrade-strategy)
45+
- [Additional Details](#additional-details)
46+
- [Test Plan](#test-plan)
47+
- [Graduation Criteria](#graduation-criteria)
48+
- [Version Skew Strategy](#version-skew-strategy)
49+
- [References](#references)
50+
- [Implementation History](#implementation-history)
5351

5452
## Glossary
5553

‎docs/proposal/20241003-data-disk-support.md‎

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,24 @@ status: implementable
1616

1717
## Table of Contents
1818

19-
* [CAPV ControlPlane Failure Domain](#capv-controlplane-failure-domain)
20-
* [Table of Contents](#table-of-contents)
21-
* [Glossary](#glossary)
22-
* [Summary](#summary)
23-
* [Motivation](#motivation)
24-
* [Goals](#goals)
25-
* [Non-Goals/Future Work](#non-goalsfuture-work)
26-
* [Proposal](#proposal)
27-
* [User Stories](#user-stories)
28-
* [Story 1](#story-1)
29-
* [Story 2](#story-2)
30-
* [Requirements](#requirements)
31-
* [Functional Requirements](#functional-requirements)
32-
* [Overall Design](#overall-design)
33-
* [For User Story 1](#for-user-story-1)
34-
* [For User Story 2](#for-user-story-2)
35-
* [API Design](#api-design)
36-
* [Implementation Details](#implementation-details)
37-
* [Notes/Constraints](#notesconstraints)
38-
* [Upgrade Strategy](#upgrade-strategy)
19+
* [Glossary](#glossary)
20+
* [Summary](#summary)
21+
* [Motivation](#motivation)
22+
* [Goals](#goals)
23+
* [Non-Goals/Future Work](#non-goalsfuture-work)
24+
* [Proposal](#proposal)
25+
* [User Stories](#user-stories)
26+
* [Story 1](#story-1)
27+
* [Story 2](#story-2)
28+
* [Requirements](#requirements)
29+
* [Functional Requirements](#functional-requirements)
30+
* [Overall Design](#overall-design)
31+
* [For User Story 1](#for-user-story-1)
32+
* [For User Story 2](#for-user-story-2)
33+
* [API Design](#api-design)
34+
* [Implementation Details](#implementation-details)
35+
* [Notes/Constraints](#notesconstraints)
36+
* [Upgrade Strategy](#upgrade-strategy)
3937

4038
## Glossary
4139

@@ -245,4 +243,4 @@ If an existing template is modified, you will be greeted by an error message sim
245243
>vspheremachinetemplates.infrastructure.cluster.x-k8s.io "test-machine-template" was not valid:
246244
spec.template.spec: Invalid value: v1beta1.VSphereMachineTemplate{TypeMeta:v1.TypeMeta{Kind:"VSphereMachineTemplate", APIVersion:"infrastructure.cluster.x-k8s.io/v1beta1"}, ObjectMeta:v1.ObjectMeta{Name:"test-machine-template", GenerateName:"", Namespace:"openshift-cluster-api", SelfLink:"", UID:"7467ba3f-758e-4873-afc3-4b8ece9da737", ResourceVersion:"92227", Generation:2, CreationTimestamp:time.Date(2024, time.October, 31, 14, 35, 9, 0, time.Local), DeletionTimestamp:<nil>, DeletionGracePeriodSeconds:(*int64)(nil), Labels:map[string]string(nil), Annotations:map[string]string(nil), OwnerReferences:[]v1.OwnerReference{v1.OwnerReference{APIVersion:"cluster.x-k8s.io/v1beta1", Kind:"Cluster", Name:"ngirard-multi-qxkhh", UID:"7c3030d9-8caa-40e2-a62c-db16d0749fb5", Controller:(*bool)(nil), BlockOwnerDeletion:(*bool)(nil)}}, Finalizers:[]string(nil), ManagedFields:[]v1.ManagedFieldsEntry{v1.ManagedFieldsEntry{Manager:"kubectl-create", Operation:"Update", APIVersion:"infrastructure.cluster.x-k8s.io/v1beta1", Time:time.Date(2024, time.October, 31, 14, 35, 9, 0, time.Local), FieldsType:"FieldsV1", FieldsV1:(*v1.FieldsV1)(0xc000ace450), Subresource:""}, v1.ManagedFieldsEntry{Manager:"cluster-api-controller-manager", Operation:"Update", APIVersion:"infrastructure.cluster.x-k8s.io/v1beta1", Time:time.Date(2024, time.October, 31, 14, 35, 58, 0, time.Local), FieldsType:"FieldsV1", FieldsV1:(*v1.FieldsV1)(0xc000ace4e0), Subresource:""}, v1.ManagedFieldsEntry{Manager:"kubectl-edit", Operation:"Update", APIVersion:"infrastructure.cluster.x-k8s.io/v1beta1", Time:time.Date(2024, time.November, 4, 13, 31, 33, 0, time.Local), FieldsType:"FieldsV1", FieldsV1:(*v1.FieldsV1)(0xc000ace510), Subresource:""}}}, Spec:v1beta1.VSphereMachineTemplateSpec{Template:v1beta1.VSphereMachineTemplateResource{ObjectMeta:v1beta1.ObjectMeta{Labels:map[string]string(nil), Annotations:map[string]string(nil)}, Spec:v1beta1.VSphereMachineSpec{VirtualMachineCloneSpec:v1beta1.VirtualMachineCloneSpec{Template:"CAPV_2_Disk", CloneMode:"linkedClone", Snapshot:"", Server:"vcenter.ci.ibmc.devcluster.openshift.com", Thumbprint:"", Datacenter:"cidatacenter", Folder:"/cidatacenter/vm/ngirard-multi-qxkhh", Datastore:"/cidatacenter/datastore/vsanDatastore", StoragePolicyName:"", ResourcePool:"/cidatacenter/host/cicluster", Network:v1beta1.NetworkSpec{Devices:[]v1beta1.NetworkDeviceSpec{v1beta1.NetworkDeviceSpec{NetworkName:"ci-vlan-1240", DeviceName:"", DHCP4:true, DHCP6:false, Gateway4:"", Gateway6:"", IPAddrs:[]string(nil), MTU:(*int64)(nil), MACAddr:"", Nameservers:[]string(nil), Routes:[]v1beta1.NetworkRouteSpec(nil), SearchDomains:[]string(nil), AddressesFromPools:[]v1.TypedLocalObjectReference(nil), DHCP4Overrides:(*v1beta1.DHCPOverrides)(nil), DHCP6Overrides:(*v1beta1.DHCPOverrides)(nil), SkipIPAllocation:false}}, Routes:[]v1beta1.NetworkRouteSpec(nil), PreferredAPIServerCIDR:""}, NumCPUs:4, NumCoresPerSocket:0, MemoryMiB:16384, DiskGiB:128, AdditionalDisksGiB:[]int32(nil), CustomVMXKeys:map[string]string(nil), TagIDs:[]string(nil), PciDevices:[]v1beta1.PCIDeviceSpec(nil), OS:"", HardwareVersion:"", DataDisks:[]v1beta1.VSphereDisk{v1beta1.VSphereDisk{Name:"", SizeGiB:69}, v1beta1.VSphereDisk{Name:"", SizeGiB:27}}}, ProviderID:(*string)(nil), FailureDomain:(*string)(nil), PowerOffMode:"hard", GuestSoftPowerOffTimeout:(*v1.Duration)(nil)}}}}: VSphereMachineTemplate spec.template.spec field is immutable. Please create a new resource instead.
247245
248-
This is why existing templates will need to be recreated if attempting to add data disks to the definition.
246+
This is why existing templates will need to be recreated if attempting to add data disks to the definition.

‎hack/verify-licenses.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ if [[ "${TRACE-0}" == "1" ]]; then
2222
set -o xtrace
2323
fi
2424

25-
# This list is from https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md
25+
# This list is from https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md
2626
CNCF_LICENSE_ALLOWLIST=Apache-2.0,MIT,BSD-2-Clause,SD-2-Clause-FreeBSD,BSD-3-Clause,ISC,Python-2.0,PostgreSQL,X11,Zlib
2727

2828
VERSION=${1}
@@ -35,4 +35,4 @@ TRIVY="${REPO_ROOT}/hack/tools/bin/trivy/${VERSION}/trivy"
3535
$TRIVY filesystem . --license-full --ignored-licenses ${CNCF_LICENSE_ALLOWLIST} --scanners license --severity UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL -f json | \
3636
# Specifically ignore 'github.com/hashicorp/hcl'. This is a known indirect dependency that we should remove where possible.
3737
# This query ensures we only skip github.com/hashicorp/hcl for as long as the license remains MPL-2.0
38-
jq '.Results[] | select( .Licenses[]?.PkgName == "github.com/hashicorp/hcl" and .Licenses[]?.Name == "MPL-2.0" | not) | if . == {} then . else error(.) end'
38+
jq '.Results[] | select( .Licenses[]?.PkgName == "github.com/hashicorp/hcl" and .Licenses[]?.Name == "MPL-2.0" | not) | if . == {} then . else error(.) end'

‎test/infrastructure/vcsim/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ vcsim controller is a regular Kubernetes controller designed to be run aside to
99
as a target infrastructure instead of a real vCenter.
1010

1111
It is also worth to notice that vcsim controller leverages several components from Cluster API's in-memory
12-
provider, and thus it is recommended to become familiar with this [document](https://github.com/kubernetes-sigs/cluster-api/blob/main/test/infrastructure/inmemory/README.md)
12+
provider, and thus it is recommended to become familiar with this [document](https://github.com/kubernetes-sigs/cluster-api/blob/main/test/infrastructure/docker/internal/controllers/backends/inmemory/README.md)
1313
before reading the following paragraphs.
1414

1515
### Preparing a test environment (using vcsim)
@@ -191,13 +191,13 @@ runtime extension, so it is possible to deploy it leveraging on the existing mac
191191
After starting tilt with `make tilt-up`, you can use the [vcsim.sh](scripts/vcsim.sh) script and the instruction above
192192
to create a test cluster.
193193

194-
See [Developing Cluster API with Tilt](https://cluster-api.sigs.k8s.io/developer/tilt) for more details.
194+
See [Developing Cluster API with Tilt](https://cluster-api.sigs.k8s.io/developer/core/tilt) for more details.
195195

196196
### E2E tests
197197

198198
vsim can be used to run a subset of CAPV E2E tests that can be executed by setting `GINKGO_FOCUS="\[vcsim\]"`.
199199

200-
See [Running the end-to-end tests locally](https://cluster-api.sigs.k8s.io/developer/testing#running-the-end-to-end-tests-locally) for more details.
200+
See [Running the end-to-end tests locally](https://cluster-api.sigs.k8s.io/developer/core/testing#running-the-end-to-end-tests-locally) for more details.
201201

202202
Note: The code for the E2E test setup will take care of creating the `VCenterSimulator`, the `ControlPlaneEndpoint`
203203
and to grab required variables from the corresponding `EnvVar`.

‎test/infrastructure/vm-operator/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ NOTE: net-operator is not represented for sake of simplicity, it is complementar
8484

8585
A subset of CAPV E2E tests can be executed using the supervisor mode by setting `GINKGO_FOCUS="\[supervisor\]"`.
8686

87-
See [Running the end-to-end tests locally](https://cluster-api.sigs.k8s.io/developer/testing#running-the-end-to-end-tests-locally) for more details.
87+
See [Running the end-to-end tests locally](https://cluster-api.sigs.k8s.io/developer/core/testing#running-the-end-to-end-tests-locally) for more details.
8888

8989
Note: The code responsible for E2E tests setup will take care of ensuring the management cluster
9090
and vCenter have all the dependencies required by the vm-operator; The only exception is the Content Library with

0 commit comments

Comments
 (0)