diff --git a/src/content/tutorials/continuous-deployment/apps/add-app-template.md b/src/content/tutorials/continuous-deployment/apps/add-app-template.md index 7fe19888da..cd7336e121 100644 --- a/src/content/tutorials/continuous-deployment/apps/add-app-template.md +++ b/src/content/tutorials/continuous-deployment/apps/add-app-template.md @@ -71,7 +71,7 @@ Reference [the app configuration]({{< relref "/tutorials/fleet-management/app-pl After running the `kubectl gs` command you can observe the output has an `App` resource together with the `ConfigMap`. Instead, you could rely on the `ConfigMap` generator feature of [Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/#generating-resources) to generate it on the fly. -__Warning__: `Kustomize` can't be used for the secrets as they need to be encrypted before commit. Refer to our [adding an app](./add_appcr.md) docs to check how to do it. +__Warning__: `Kustomize` can't be used for the secrets as they need to be encrypted before commit. Refer to our [adding an app]({{< relref "/tutorials/continuous-deployment/apps/add-appcr" >}}) docs to check how to do it. In the last step it's time to create the `kustomization.yaml` file, adding the optional `Secret` or `ConfigMap` as resources and/or using a `ConfigMap` generator to manage plain configuration: diff --git a/src/content/tutorials/continuous-deployment/bases/index.md b/src/content/tutorials/continuous-deployment/bases/index.md index dc48324f1a..ec3c0e678b 100644 --- a/src/content/tutorials/continuous-deployment/bases/index.md +++ b/src/content/tutorials/continuous-deployment/bases/index.md @@ -80,7 +80,7 @@ In this example you create a custom version for AWS base: mkdir -p bases/clusters/capa/v0.21.0 ``` -2. Use the [kubectl gs template cluster](/use-the-api/kubectl-gs/template-cluster/) to template cluster resources, see an example for the `capa` provider below. Use arbitrary values for the mandatory fields, we will configure them later in our process: +2. Use the [kubectl gs template cluster]({{< relref "/reference/kubectl-gs/template-cluster" >}}) to template cluster resources, see an example for the `capa` provider below. Use arbitrary values for the mandatory fields, we will configure them later in our process: ```nohighlight kubectl gs template cluster \ diff --git a/src/content/tutorials/continuous-deployment/environments/index.md b/src/content/tutorials/continuous-deployment/environments/index.md index 63e1c2f3de..0241f65077 100644 --- a/src/content/tutorials/continuous-deployment/environments/index.md +++ b/src/content/tutorials/continuous-deployment/environments/index.md @@ -182,7 +182,7 @@ resources: - ../../../../../../../../bases/clusters/capa/v0.21.0/ ``` -__Warning__: For the sake of simplicity both reference the same base template, but in some occasions where there are breaking changes you might need to link a different template. [Read more about bases here](/advanced/gitops/bases/). +__Warning__: For the sake of simplicity both reference the same base template, but in some occasions where there are breaking changes you might need to link a different template. [Read more about bases here]({{< relref "/tutorials/continuous-deployment/bases" >}}). Now, you define the production configuration in a new file `cluster_config.yaml`. You can configure this time a completely different value set, even override new configurations from default. diff --git a/src/content/vintage/advanced/gitops/apps/add_app_template.md b/src/content/vintage/advanced/gitops/apps/add-app-template.md similarity index 91% rename from src/content/vintage/advanced/gitops/apps/add_app_template.md rename to src/content/vintage/advanced/gitops/apps/add-app-template.md index 1038faf910..7e68d45b83 100644 --- a/src/content/vintage/advanced/gitops/apps/add_app_template.md +++ b/src/content/vintage/advanced/gitops/apps/add-app-template.md @@ -73,7 +73,7 @@ export APP_USER_VALUES=CONFIGMAP_OR_SECRET_PATH In case you used `kubectl gs` command you realized the output is an App Custom Resource plus the ConfigMap. In case you want to manage the values in plain YAML, you could rely on the ConfigMap generator feature of [Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/#generating-resources). - __Warning__: It can not be used for the Secrets as they need to be encrypted before commit into the Git Repository. Refer to our [adding an App](./add_appcr.md) docs to check how to add and encrypt a Secret. + __Warning__: It can not be used for the Secrets as they need to be encrypted before commit into the Git Repository. Refer to our [adding an App]({{< relref "/vintage/advanced/gitops/apps/add-appcr" >}}) docs to check how to add and encrypt a Secret. 3. Now it is time to create the `kustomization.yaml` file, adding the optional Secret/ConfigMap as resources and/or using a ConfigMapGenerator to manage plain configuration: @@ -95,9 +95,9 @@ export APP_USER_VALUES=CONFIGMAP_OR_SECRET_PATH # You can add here the config map in case of generate it via kubectl gs command or manually ``` -At this point, you should have a ready app template. You can use it to [add a new App to a Workload Cluster](/advanced/gitops/apps/add_appcr/). +At this point, you should have a ready app template. You can use it to [add a new App to a Workload Cluster]({{< relref "/vintage/advanced/gitops/apps/add-appcr" >}}). ## Recommended next steps -- [Add a new App to a Workload Cluster](/advanced/gitops/apps/add_appcr/) -- [Creating and using App Sets](/advanced/gitops/apps/app_sets/) +- [Add a new App to a Workload Cluster]({{< relref "/vintage/advanced/gitops/apps/add-appcr" >}}) +- [Creating and using App Sets]({{< relref "/vintage/advanced/gitops/apps/app-sets" >}}) diff --git a/src/content/vintage/advanced/gitops/apps/add_appcr.md b/src/content/vintage/advanced/gitops/apps/add-appcr.md similarity index 95% rename from src/content/vintage/advanced/gitops/apps/add_appcr.md rename to src/content/vintage/advanced/gitops/apps/add-appcr.md index 05f1f4ba5b..cc97cf1662 100644 --- a/src/content/vintage/advanced/gitops/apps/add_appcr.md +++ b/src/content/vintage/advanced/gitops/apps/add-appcr.md @@ -131,7 +131,7 @@ export APP_NAME="${WC_NAME}-APP_NAME" ## Adding App using App Template -1. First, you need to pick a directory with an App Template from the `bases/apps` dir created in the [template creation page](/advanced/gitops/apps/add_app_template/). Export the path to the directory in an env variable: +1. First, you need to pick a directory with an App Template from the `bases/apps` dir created in the [template creation page]({{< relref "/vintage/advanced/gitops/apps/add-app-template" >}}). Export the path to the directory in an env variable: ```nohighlight export APP_TEMPLATE_DIR=[YOUR_BASE_PATH] @@ -189,5 +189,5 @@ Please note, that the block marked "configuration override block" is needed only ## Recommended next steps -- [Enable automatic updates of an existing App](/advanced/gitops/apps/automatic_updates_appcr/) -- [Update an existing App](/advanced/gitops/apps/update_appcr/) +- [Enable automatic updates of an existing App]({{< relref "/vintage/advanced/gitops/apps/automatic-updates-appcr" >}}) +- [Update an existing App]({{< relref "/vintage/advanced/gitops/apps/update-appcr" >}}) diff --git a/src/content/vintage/advanced/gitops/apps/app_sets.md b/src/content/vintage/advanced/gitops/apps/app-sets.md similarity index 89% rename from src/content/vintage/advanced/gitops/apps/app_sets.md rename to src/content/vintage/advanced/gitops/apps/app-sets.md index c16c6a17cc..fb7cd5d000 100644 --- a/src/content/vintage/advanced/gitops/apps/app_sets.md +++ b/src/content/vintage/advanced/gitops/apps/app-sets.md @@ -45,7 +45,7 @@ An example showing how to use an App Set is available in the [gitops-template re ## Creating an App Set Template -Creating an App Set Template is not much different than [creating an App Template](/advanced/gitops/apps/add_app_template/). Please make sure to read the documentation first. +Creating an App Set Template is not much different than [creating an App Template]({{< relref "/vintage/advanced/gitops/apps/add-app-template" >}}). Please make sure to read the documentation first. To get started, go to the `bases` directory and create a subdirectory for your App Set Template. In this directory, create a `kustomization.yaml` similar to the one below: @@ -96,11 +96,11 @@ Please note the following in the example above: - One of the key benefits of App Sets is to be able to provide a specific set of app versions, that is known to make the apps work well together. Over here, we do that as a set of in-line patches, so it is immediately visible in the `kustomization.yaml` file which versions are used. - When using `App` CRs, we have two configuration slots available: `config` and `userConfig`. Since we always want to leave `userConfig` at the end users disposal, we're left with overriding the whole ConfigMap coming from the base application as the only option. - It is recommended to re-use App Templates to create App Set Templates. That's exactly what we do here: apps defined in the `resources:` block are App Templates, that, if needed, can be also used standalone. -- The example above doesn't cover handling Secrets - we do that for brevity. Secrets can be created the same way as in normal [app templates]({{< relref "/tutorials/continuous-deployment/apps/add-app-template" >}}) and overrode the same as `ConfigMaps` or `Secrets` when creating [app from a template](/advanced/gitops/apps/add_appcr/#adding-app-using-app-template). +- The example above doesn't cover handling Secrets - we do that for brevity. Secrets can be created the same way as in normal [app templates]({{< relref "/tutorials/continuous-deployment/apps/add-app-template" >}}) and overrode the same as `ConfigMaps` or `Secrets` when creating [app from a template]({{< relref "/vintage/advanced/gitops/apps/add-appcr#adding-app-using-app-template" >}}). ## Using an App Set -Using an App Set Template is once again very similar to using a single [App Set](/advanced/gitops/apps/add_appcr/#adding-app-using-app-template). To create one, save a path that contains your desired App Set Template in the [gitops-template repository in "bases/app_sets"](https://github.com/giantswarm/gitops-template/tree/main/bases/app_sets/) directory. Then, create a new directory in the `app_sets` directory of your Working Cluster. In that directory, create a `kustomization.yaml` file based on the following pattern: +Using an App Set Template is once again very similar to using a single [App Set]({{< relref "/vintage/advanced/gitops/apps/add-appcr#adding-app-using-app-template" >}}). To create one, save a path that contains your desired App Set Template in the [gitops-template repository in "bases/app_sets"](https://github.com/giantswarm/gitops-template/tree/main/bases/app_sets/) directory. Then, create a new directory in the `app_sets` directory of your Working Cluster. In that directory, create a `kustomization.yaml` file based on the following pattern: ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 @@ -119,4 +119,4 @@ resources: - ../../../../../../../../../bases/app_sets/hello-web-app ``` -Over here, we are overriding the configuration of the `hello-world` app, which was already defined in the App Set Template. Since here we're using the `userConfig` property, we don't have to override the whole config, but only the YAML keys we need to change. One more important fact is that we're setting a custom Namespace for the whole deployment of an app. If you want to learn more about how config overrides work, please consult our [docs about creating apps](/advanced/gitops/apps/add_appcr/), as in general App Set is just a bundle of them. +Over here, we are overriding the configuration of the `hello-world` app, which was already defined in the App Set Template. Since here we're using the `userConfig` property, we don't have to override the whole config, but only the YAML keys we need to change. One more important fact is that we're setting a custom Namespace for the whole deployment of an app. If you want to learn more about how config overrides work, please consult our [docs about creating apps]({{< relref "/vintage/advanced/gitops/apps/add-appcr" >}}), as in general App Set is just a bundle of them. diff --git a/src/content/vintage/advanced/gitops/apps/automatic_updates_appcr.md b/src/content/vintage/advanced/gitops/apps/automatic-updates-appcr.md similarity index 100% rename from src/content/vintage/advanced/gitops/apps/automatic_updates_appcr.md rename to src/content/vintage/advanced/gitops/apps/automatic-updates-appcr.md diff --git a/src/content/vintage/advanced/gitops/apps/update_appcr.md b/src/content/vintage/advanced/gitops/apps/update-appcr.md similarity index 100% rename from src/content/vintage/advanced/gitops/apps/update_appcr.md rename to src/content/vintage/advanced/gitops/apps/update-appcr.md