Skip to content

Commit

Permalink
Merge pull request #5123 from willie-yao/fix-links
Browse files Browse the repository at this point in the history
Fix documentation links hard-coded to capz.k8s.io
  • Loading branch information
k8s-ci-robot authored Sep 10, 2024
2 parents b4b5087 + d857e8c commit 25d5985
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ about: Tell us about a problem you are experiencing.

/kind bug

[Before submitting an issue, have you checked the [Troubleshooting Guide](https://capz.sigs.k8s.io/topics/troubleshooting.html)?]
[Before submitting an issue, have you checked the Troubleshooting Guide [self-managed](https://capz.sigs.k8s.io/self-managed/troubleshooting.html) & [managed](https://capz.sigs.k8s.io/managed/troubleshooting.html)?]

**What steps did you take and what happened:**
[A clear and concise description of what the bug is.]
Expand Down
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Quick start

- [Getting started](https://capz.sigs.k8s.io/topics/getting-started.html)
- [Getting started](https://capz.sigs.k8s.io/getting-started.html)
- [Cluster API quick start](https://cluster-api.sigs.k8s.io/user/quick-start.html)

## Features
Expand All @@ -22,7 +22,8 @@

## Troubleshooting

- [Troubleshooting guide](https://capz.sigs.k8s.io/topics/troubleshooting.html)
- [Self-managed troubleshooting guide](https://capz.sigs.k8s.io/self-managed/troubleshooting.html)
- [Managed troubleshooting guide](https://capz.sigs.k8s.io/managed/troubleshooting.html)

## Docs contributors

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Azure Service Operator (ASO) is automatically installed with CAPZ and can be uti
CAPZ can provision three major types of clusters, each of which have a different investment priority.

1. Self-Managed clusters - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests.
2. Managed clusters (AzureManaged* current API) - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests. It is recommended that the existing [asoManaged*Patches functionality](https://capz.sigs.k8s.io/topics/managedcluster#warning-warning-this-is-meant-to-be-used-sparingly-to-enable-features-for-development-and-testing-that-are-not-otherwise-represented-in-the-capz-api-misconfiguration-that-conflicts-with-capzs-normal-mode-of-operation-is-possible) be considered as a stop-gap to missing features in the CAPZ definitions for AKS.
2. Managed clusters (AzureManaged* current API) - maintain the current functionality via bug fixes and security patches. New features will be accepted via contributor pull requests. It is recommended that the existing [asoManaged*Patches functionality](./managed/managedcluster.md#warning-warning-this-is-meant-to-be-used-sparingly-to-enable-features-for-development-and-testing-that-are-not-otherwise-represented-in-the-capz-api-misconfiguration-that-conflicts-with-capzs-normal-mode-of-operation-is-possible) be considered as a stop-gap to missing features in the CAPZ definitions for AKS.
See deprecation timeline below.
3. Managed clusters (AzureASOManaged* new API) - was moved out of experimentation in July for the 1.16 release and is where the investment lies moving forward for provisioning AKS clusters.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/self-managed/addons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

This section provides examples for addons for self-managed clusters. For managed cluster addons, please go to the [managed cluster specifications](https://capz.sigs.k8s.io/topics/managedcluster.html#specification).
This section provides examples for addons for self-managed clusters. For managed cluster addons, please go to the [managed cluster specifications](../managed/managedcluster.md#specification).

Self managed cluster addon options covered here:

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/self-managed/custom-vnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ spec:
resourceGroup: cluster-vnet-peering
```

Currently, only virtual networks on the same subscription can be peered. Also, note that when creating workload clusters with internal load balancers, the management cluster must be in the same VNet or a peered VNet. See [here](https://capz.sigs.k8s.io/topics/api-server-endpoint.html#warning) for more details.
Currently, only virtual networks on the same subscription can be peered. Also, note that when creating workload clusters with internal load balancers, the management cluster must be in the same VNet or a peered VNet. See [here](./api-server-endpoint.md#warning) for more details.

## Custom Network Spec

Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/self-managed/publicmec-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ Execute clusterctl to template the resources:
clusterctl init --infrastructure azure
clusterctl generate cluster ${CLUSTER_NAME} --kubernetes-version ${KUBERNETES_VERSION} --flavor edgezone > edgezone-cluster.yaml
```
Public MEC doesn't have access to CAPI images in Azure Marketplace, therefore, users need to prepare CAPI image by themselves. You can follow doc [Custom Images](https://capz.sigs.k8s.io/topics/custom-images.html) to setup custom image.
Public MEC doesn't have access to CAPI images in Azure Marketplace, therefore, users need to prepare CAPI image by themselves. You can follow doc [Custom Images](./custom-images.md) to setup custom image.

Apply the modified template to your kind management cluster:
```bash
kubectl apply -f edgezone-cluster.yaml
```

Once target cluster's control plane is up, install [Azure cloud provider components](https://github.com/kubernetes-sigs/cloud-provider-azure/tree/master/helm/cloud-provider-azure) by helm. The minimum version for "out-of-tree" Azure cloud provider is v1.0.3, "in-tree" Azure cloud provider is not supported. (Reference: https://capz.sigs.k8s.io/topics/addons.html#external-cloud-provider)
Once target cluster's control plane is up, install [Azure cloud provider components](https://github.com/kubernetes-sigs/cloud-provider-azure/tree/master/helm/cloud-provider-azure) by helm. The minimum version for "out-of-tree" Azure cloud provider is v1.0.3, "in-tree" Azure cloud provider is not supported. (Reference: ./addons.md#external-cloud-provider)

```bash
# get the kubeconfig of the cluster
Expand Down

0 comments on commit 25d5985

Please sign in to comment.