Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in FAQ docs #665

Merged
merged 2 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions en/docs/about-apk/FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,15 @@ APK is primarily meant for anyone who wants API management in the Kubernetes dom

### 1. What are the minimum requirements needed to run WSO2 APK?

Refer to the <a href="{{base_path}}/en/{{site_version}}/setup/prerequisites#prerequisites" target="_blank">prerequisites</a> section for this information.
Refer to the <a href="../../setup/prerequisites#prerequisites" target="_blank">prerequisites</a> section for this information.

### 2. I want to customize some configurations in my Helm deployment. How can I do this?

Refer to the <a href="{{base_path}}/en/{{site_version}}/setup/customize-configurations#customize-configurations" target="_blank">customize configurations</a> section for this information.

Refer to the <a href="../../setup/Customize-Configurations" target="_blank">customize configurations</a> section for this information.

### 3. What are the Kubernetes distributions supported by WSO2 APK?

Minikube, Rancher, Kind and Openshift are supported. For more information about the supported versions, please refer to the <a href="{{base_path}}/en/{{site_version}}/setup/prerequisites#kubernetes-distributions" target="_blank">supported Kubernetes distributions</a> section.
Minikube, Rancher, Kind and Openshift are supported. For more information about the supported versions, please refer to the <a href="../../setup/prerequisites#kubernetes-distributions" target="_blank">supported Kubernetes distributions</a> section.

### 4. Why are pods not transitioning to the running state for a long time?

Expand Down Expand Up @@ -175,21 +174,21 @@ Currently, WSO2 APK supports REST APIs, GraphQL APIs and gRPC APIs.

Yes, you can.

Refer to the <a href="{{base_path}}/en/{{site_version}}/create-api/create-and-attach-api-policies/interceptors/interceptors-overview" target="_blank">Interceptors documentation</a> for information on how to configure an Interceptor service.
Refer to the <a href="../../create-api/create-and-attach-api-policies/interceptors/interceptors-overview" target="_blank">Interceptors documentation</a> for information on how to configure an Interceptor service.

Alternatively, you can refer to <a href="{{base_path}}/en/{{site_version}}/create-api/create-and-attach-api-policies/header-modifier-filters/overview" target="_blank">Header modification filters</a> for header modification support.
Alternatively, you can refer to <a href="../../create-api/create-and-attach-api-policies/header-modifier-filters/overview" target="_blank">Header modification filters</a> for header modification support.

### 3. What are the CRDs used in WSO2 APK?

Refer to the <a href="{{base_path}}/en/{{site_version}}/catalogs/kubernetes-crds" target="_blank">CRD catalog</a> for details on the CRDs used in the APK, including examples and the configuration definitions.
Refer to the <a href="../../catalogs/kubernetes-crds" target="_blank">CRD catalog</a> for details on the CRDs used in the APK, including examples and the configuration definitions.

## Security

### 1. What are the different methods available for API authentication?
Currently, APK supports OAuth 2.0 and mutualSSL for API authentication.

### 2. Can I use a custom authorization header?
Yes, a custom authorization header can be used. Refer to the [Use custom bearer header name](..//develop-and-deploy-api/security/authentication/enable-api-security/oauth2.md) for instructions to configure this.
Yes, a custom authorization header can be used. Refer to the <a href="../../develop-and-deploy-api/security/authentication/enable-api-security/oauth2" target="_blank">Use custom bearer header name</a> for instructions to configure this.

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adapter Log Configurations

To configure Adapter logs, update the `values.yaml`'s `wso2.apk.dp.adapter.logging` section with the following values. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
To configure Adapter logs, update the `values.yaml`'s `wso2.apk.dp.adapter.logging` section with the following values. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.

```yaml
logging:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ As the Enforcer component is implemented in Java, we are using the `log4j2` fram

## Configuring Log4j2 Properties

To configure log4j2 properties, update the `values.yaml`'s `wso2.apk.dp.gatewayRuntime.deployment.enforcer.logging` section with the following values. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
To configure log4j2 properties, update the `values.yaml`'s `wso2.apk.dp.gatewayRuntime.deployment.enforcer.logging` section with the following values. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.

```yaml
logging:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Both these files are located in the same ConfigMap file located in the following
apk/helm-charts/templates/data-plane/gateway-components/log-conf.yaml
```

These configurations can be set using the `values.yaml` file. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file. Follow each section to configure the logs for each of the components.
These configurations can be set using the `values.yaml` file. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file. Follow each section to configure the logs for each of the components.

## Error Codes in Logs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

As the APK uses an Envoy proxy as the Router component, it only supports the logging mechanisms provided by the Envoy proxy. In the following sections, you may find how to enable Router access logs and debug logs.

To set up Router Logs, start by following the instructions outlined in [Customize Configurations](../../setup/customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the log configurations to your specific needs.
To set up Router Logs, start by following the instructions outlined in [Customize Configurations](../../setup/Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the log configurations to your specific needs.

## Router Access Logging

Expand Down
2 changes: 1 addition & 1 deletion en/docs/administration/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Supported distributed tracing systems,

## Configure Distributed Tracing

To set up distributed tracing, start by following the instructions outlined in [Customize Configurations](../setup/customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the tracing configurations to your specific needs.
To set up distributed tracing, start by following the instructions outlined in [Customize Configurations](../setup/Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the tracing configurations to your specific needs.

!!! note
If you are trying out tracing capabilities of APK and do not have an actual deployment of Jaeger or Zipkin, you can start APK together with Jaeger/Zipkin by applying the below kubernetes artifacts to your cluster.
Expand Down
2 changes: 1 addition & 1 deletion en/docs/control-plane/deploy-apim-apk-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Follow the instructions below to deploy the APIM APK Agent.
```

!!! Optional
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.

=== "Command"
```
Expand Down
2 changes: 1 addition & 1 deletion en/docs/includes/customize-installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in <a href="../../setup/customize-configurations" target="_blank">Customize Configurations</a> will guide you through the process of acquiring the `values.yaml` file.
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in <a href="../../setup/Customize-Configurations" target="_blank">Customize Configurations</a> will guide you through the process of acquiring the `values.yaml` file.

=== "Command"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
kubectl create secret generic <secret-name> --from-literal=authToken='<choreo-on-prem-key>' --from-literal=authURL='https://analytics-event-auth.choreo.dev/auth/v1' -n <namespace>
```

2. Follow the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the analytics configurations to your specific needs.
2. Follow the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the analytics configurations to your specific needs.
3. Replace `secret-name` in the following configuration with the name of the secret you created in the previous step.
```yaml
analytics:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Step 1 - Setup APK

1. Start by following the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
1. Start by following the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.

2. Open the `values.yaml` file, and add the configuration given below to the `gatewayRuntime` section under `dp`.
```yaml
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/analytics/configure-analytics-for-moesif.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
kubectl create secret generic <secret-name> --from-literal=moesifToken='<moesif-collector-application-id>' -n <namespace>
```

2. Follow the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
2. Follow the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.

3. Replace ```secret-name``` in the following configuration with the name of the secret you created in the previous step.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/configure-hpa.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ When the traffic to your pods increase, the deployment may need to scale horizon

To configure HPA for gateway, follow these steps.

1. Obtain the `values.yaml` file for your deployment by following the instructions in [Customize Configurations](../setup/customize-configurations.md).
1. Obtain the `values.yaml` file for your deployment by following the instructions in [Customize Configurations](../setup/Customize-Configurations.md).
2. Update the following configuration with your required values.
```
autoscaling:
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/enterprise-apim-apk-agent-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Install the [prerequisites](../../setup/prerequisites) that are required to run
```

!!! Optional
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.

=== "Command"
```
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/enterprise-apk-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Install the [prerequisites](../../setup/prerequisites) that are required to run
```

!!! Optional
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.

=== "Command"
```
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/identity-platform/idp/asgardeo-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Follow the instructions below to use Asgardeo as the Identity Provider (IdP) to

## Step 5 - Update the Helm Chart

1. Follow the instructions outlined in [Customize Configurations](../../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
1. Follow the instructions outlined in [Customize Configurations](../../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
2. Update the IDP related configurations in the `idp` section.
3. Create a K8s Secret with retrieved `clientId` and `clientSecret` from Step 4 with name `apk-idp-secret`.
```
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/identity-platform/idp/auth0-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ You need to add a [custom claim](https://auth0.com/docs/secure/tokens/json-web-t

## Step 6 - Update the Helm Chart

1. Follow the instructions outlined in [Customize Configurations](../../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
1. Follow the instructions outlined in [Customize Configurations](../../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
2. Update the IDP related configurations in the `idp` section.
3. Create a K8s Secret with retrieved `clientId` and `clientSecret` from Step 4 with name `apk-idp-secret`.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/identity-platform/idp/third-party-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ This includes setting the application's settings, such as the application name a

## Step 6 - Update the Helm Chart

1. Follow the instructions outlined in [Customize Configurations](../../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
1. Follow the instructions outlined in [Customize Configurations](../../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
2. Update the IDP related configurations in the `idp` section.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion en/docs/setup/production-deployment-guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document provide the steps for APK production deployment.

WSO2 APK can be configured through `values.yaml` file. Please refer to [Customize Configurations](../setup/customize-configurations.md) for information on how to use a customized values file for APK deployment. When deploying WSO2 APK in a production environment, we strongly recommend following these guidelines.
WSO2 APK can be configured through `values.yaml` file. Please refer to [Customize Configurations](../setup/Customize-Configurations.md) for information on how to use a customized values file for APK deployment. When deploying WSO2 APK in a production environment, we strongly recommend following these guidelines.

## Choose the correct deployment pattern

Expand Down
2 changes: 1 addition & 1 deletion en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ nav:
- CI/CD for APIs - Overview: setup/cicd/overview.md
- Building a GitOps Workflow for APIs With WSO2 APK: setup/cicd/building-a-pipeline.md
- Migration: setup/migration.md
- Customize Configurations: setup/customize-configurations.md
- Customize Configurations: setup/Customize-Configurations.md
- Production Deployment Guidelines: setup/production-deployment-guideline.md
- Configure HPA for gateway: setup/configure-hpa.md
- Deploy in OpenShift: setup/deploy-in-openshift.md
Expand Down