Skip to content

Commit cd1bd9a

Browse files
authored
Fixed broken links in GH pages docs (#1736)
1 parent 3c33b24 commit cd1bd9a

File tree

6 files changed

+14
-21
lines changed

6 files changed

+14
-21
lines changed

docs/.index

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
title: Page Title
21
collapse: true
32
arrange:
43
- index.md
@@ -11,4 +10,4 @@ arrange:
1110
- how-tos
1211
- faq.md
1312
- troubleshootings
14-
theme: readthedocs
13+
theme: readthedocs

docs/developers/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The file will contain a JSON blob with the following shape:
4747

4848
### Deploy Application Gateway and AKS
4949

50-
To deploy a fresh setup, please follow the steps for template deployment in the [greenfield](../setup/install-new.md) documentation.
50+
To deploy a fresh setup, please follow the steps for template deployment in the [greenfield](../setup/install.md) documentation.
5151

5252
### Using startup script
5353

docs/developers/design.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Let's take a look at each component:
3131
When any change is applied on the k8s cluster by the user, AGIC needs to listen to these changes in order to update the corresponding configuration on the Application Gateway.
3232
We use the kubernetes informers for this purpose which is a standard for watching resources on the K8S API server.
3333

34-
When AGIC starts, it [sets up informers](../pkg/k8scontext/context.go) for watching following resources:
34+
When AGIC starts, it [sets up informers](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/master/pkg/k8scontext/context.go) for watching following resources:
3535

3636
1. [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/): This is the top-level resource that AGIC monitors. It provides information about the layer-7 routing rules that need to be configured on the App Gateway.
3737
1. [Service](https://kubernetes.io/docs/concepts/services-networking/service/): Service provides an abstraction over the pods to expose as a network service. AGIC uses the service as logical grouping of pods to extract the IP addresses through the endpoints object created automatically along with the Service.
@@ -44,9 +44,9 @@ When starting the informers, AGIC also provides event handlers for each for crea
4444

4545
### 2. Worker
4646

47-
[Worker](../../pkg/worker.go) is responsible for processing the events and performing updates.
47+
[Worker](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/master/pkg/worker/) is responsible for processing the events and performing updates.
4848

49-
When Worker's `Run` function is called, it starts as a separate thread and waits on the `Work` channel. When an informers add an event to the channel, worker dequeues the event and checks whether the event is noise or is relevant. Events that are coming from unwatched namespaces and unreferenced pods/endpoints are skipped to reduce the churn. If the the last worker loop was run less than 1 second ago, it sleeps for the remainder and wakes up to space out the updates.
49+
When Worker's `Run` function is called, it starts as a separate thread and waits on the `Work` channel. When an informers add an event to the channel, worker dequeues the event and checks whether the event is noise or is relevant. Events that are coming from unwatched namespaces and unreferenced pods/endpoints are skipped to reduce the churn. If the the last worker loop was run less than 1 second ago, it sleeps for the remainder and wakes up to space out the updates.
5050
After this, worker starts draining the rest of the events and calling the `ProcessEvent` function to process the event.
5151

5252
`ProcessEvent` function does the following:
@@ -57,7 +57,7 @@ After this, worker starts draining the rest of the events and calling the `Proce
5757

5858
### 3. Application Gateway Config Builder
5959

60-
This [component](../../pkg/appgw/configbuilder.go) is responsible for using the information in the local kubernetes cache and generating the corresponding Application Gateway configuration as an output.
60+
This [component](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/master/pkg/appgw/configbuilder.go) is responsible for using the information in the local kubernetes cache and generating the corresponding Application Gateway configuration as an output.
6161

6262
Worker invokes the `Build` on this component which then generates various gateways sub-resources starting from leaf sub-resources like `probes`, `http settings` up to the `request routing rules`.
6363

docs/features/appgw-ssl-certificate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This documents assumes you already have the following Azure tools and resources
99
- [AAD Pod Identity](https://github.com/Azure/aad-pod-identity) installed on your AKS cluster
1010
- [Cloud Shell](https://shell.azure.com/) is the Azure shell environment, which has `az` CLI, `kubectl`, and `helm` installed. These tools are required for the commands below.
1111

12-
Please use [Greenfield Deployment](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/master/docs/setup/install-new.md) to install nonexistents.
12+
Please use [Greenfield Deployment](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/master/docs/setup/install.md) to install nonexistents.
1313

1414
To use the new feature, make sure the AGIC version is at least at 1.2.0-rc3
1515

docs/features/custom-ingress-class.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,3 @@ To use a custom ingress class,
3737
port:
3838
number: 80
3939
```
40-
41-
## Reference
42-
43-
* [Proposal Document](../../proposals\multiple-gateways-single-cluster.md)

docs/setup/install.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ You need to complete the following tasks prior to deploying AGIC on your cluster
2222

2323
2. Set an AKS cluster for your workload.
2424

25-
> AKS cluster should have the workload identity feature enabled. [Learn how](../../aks/workload-identity-deploy-cluster.md#update-an-existing-aks-cluster) to enable workload identity on an existing AKS cluster.
26-
2725
If using an existing cluster, ensure you enable Workload Identity support on your AKS cluster. Workload identities can be enabled via the following:
2826

2927
```bash
@@ -119,7 +117,7 @@ If using an existing Application Gateway, make sure the following:
119117
--http-settings-protocol Http \
120118
--public-ip-address appgw-ip \
121119
--priority 10
122-
120+
123121
APPGW_ID=$(az network application-gateway show --name $APPGW_NAME --resource-group $RESOURCE_GROUP --query "id" --output tsv)
124122
```
125123

@@ -183,7 +181,7 @@ AGIC can be installed by running the following commands:
183181
--set armAuth.identityClientID=$IDENTITY_CLIENT_ID \
184182
--set rbac.enabled=true \
185183
--version 1.7.3
186-
184+
187185
# on aks cluster with windows node pools
188186
helm install ingress-azure \
189187
oci://mcr.microsoft.com/azure-application-gateway/charts/ingress-azure \
@@ -210,7 +208,7 @@ AGIC can be upgraded by running the following commands:
210208
--set armAuth.identityClientID=$IDENTITY_CLIENT_ID \
211209
--set rbac.enabled=true \
212210
--version 1.7.3
213-
211+
214212
# on aks cluster with windows node pools
215213
helm upgrade ingress-azure \
216214
oci://mcr.microsoft.com/azure-application-gateway/charts/ingress-azure \
@@ -242,9 +240,9 @@ via [Azure Cloud Shell](https://shell.azure.com/):
242240
ports:
243241
- containerPort: 8080
244242
protocol: TCP
245-
243+
246244
---
247-
245+
248246
apiVersion: v1
249247
kind: Service
250248
metadata:
@@ -256,9 +254,9 @@ via [Azure Cloud Shell](https://shell.azure.com/):
256254
- protocol: TCP
257255
port: 80
258256
targetPort: 8080
259-
257+
260258
---
261-
259+
262260
apiVersion: networking.k8s.io/v1
263261
kind: Ingress
264262
metadata:

0 commit comments

Comments
 (0)