Skip to content

Commit

Permalink
chore: fix links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edvald committed Feb 10, 2023
1 parent 7978220 commit c5d86cc
Show file tree
Hide file tree
Showing 23 changed files with 44 additions and 37 deletions.
13 changes: 10 additions & 3 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ redirects:
examples/demo-project: ./example-projects/demo-project.md
examples/tls-project: ./example-projects/tls-project.md
examples/using-garden-in-ci: ./guides/using-garden-in-ci.md
guides/using-remote-sources: ./advanced/using-remote-sources.md
guides/cert-manager-integration: ./advanced/cert-manager-integration.md
guides/terraform: ./advanced/terraform.md
guides/terraform: ./terraform-plugin/about.md
providers/conftest-container: ./reference/providers/conftest-container.md
providers/conftest-kubernetes: ./reference/providers/conftest-kubernetes.md
providers/conftest: ./reference/providers/conftest.md
Expand All @@ -38,6 +37,14 @@ redirects:
# Redirects after docs restructure (https://github.com/garden-io/garden/pull/3467)
advanced/terraform: ./terraform-plugin/about.md
advanced/pulumi: ./pulumi-plugin/about.md
getting-started/1-installation.md: ./guides/installation.md
advanced/rbac-config: ./k8s-plugins/advanced/rbac-config.md
getting-started: ./tutorials/your-first-project.md
getting-started/0-introduction: ./basics/quickstart
getting-started/1-installation: ./guides/installation.md
getting-started/2-connect-to-a-cluster: ./tutorials/your-first-project/2-connect-to-a-cluster.md
basics/5-min-quickstart: ./basics/quickstart.md
other-plugins/container: ./other-plugins/container
guides/remote-kubernetes: ./k8s-plugins/about.md
guides/in-cluster-building: ./k8s-plugins/advanced/in-cluster-building.md
guides/using-helm-charts: ./k8s-plugins/module-types/helm.md
guides/using-remote-sources: ./k8s-plugins/advanced/using-remote-sources.md
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The project code is composed of several components, most of which are written in

### Step 1: Install Docker and Kubernetes

Please refer to our [installation docs](./docs/getting-started/1-installation.md) for instructions on how to install Docker and Kubernetes for different platforms.
Please refer to our [installation docs](./docs/guides/installation.md) for instructions on how to install Docker and Kubernetes for different platforms.

### Step 2: Clone the repo

Expand Down
2 changes: 1 addition & 1 deletion core/src/plugins/kubernetes/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ export const kubernetesConfigBase = () =>
dedent`
Choose the mechanism for building container images before deploying. By default your local Docker daemon is used, but you can set it to \`cluster-buildkit\` or \`kaniko\` to sync files to the cluster, and build container images there. This removes the need to run Docker locally, and allows you to share layer and image caches between multiple developers, as well as between your development and CI workflows.
For more details on all the different options and what makes sense to use for your setup, please check out the [in-cluster building guide](https://docs.garden.io/guides/in-cluster-building).
For more details on all the different options and what makes sense to use for your setup, please check out the [in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building).
`
),
clusterBuildkit: joi
Expand Down
2 changes: 1 addition & 1 deletion core/src/plugins/kubernetes/helm/action.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { posix } from "path"
export const helmDeployDocs = dedent`
Specify a Helm chart (either in your repository or remote from a registry) to deploy.
Refer to the [Helm guide](${DOCS_BASE_URL}/guides/using-helm-charts) for usage instructions.
Refer to the [Helm guide](${DOCS_BASE_URL}/kubernetes-plugins/module-types/helm) for usage instructions.
`

export const helmDeployDefinition = (): DeployActionDefinition<HelmDeployAction> => ({
Expand Down
4 changes: 2 additions & 2 deletions core/src/plugins/kubernetes/local/local.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ export const gardenPlugin = () =>
docs: dedent`
The \`local-kubernetes\` provider is a specialized version of the [\`kubernetes\` provider](${providerUrl}) that automates and simplifies working with local Kubernetes clusters.
For general Kubernetes usage information, please refer to the [guides section](${DOCS_BASE_URL}/guides). For local clusters a good place to start is the [Local Kubernetes guide](${DOCS_BASE_URL}/guides/local-kubernetes) guide. The [Getting Started](${DOCS_BASE_URL}/getting-started/0-introduction) guide is also helpful as an introduction.
For general Kubernetes usage information, please refer to the [Kubernetes plugin section](${DOCS_BASE_URL}/kubernetes-plugins/about) in the docs. For local clusters a good place to start is the [Local Kubernetes guide](${DOCS_BASE_URL}/kubernetes-plugins/local-k8s) guide.
If you're working with a remote Kubernetes cluster, please refer to the [\`kubernetes\` provider](${providerUrl}) docs, and the [Remote Kubernetes guide](${DOCS_BASE_URL}/guides/remote-kubernetes) guide.
If you're working with a remote Kubernetes cluster, please refer to the [\`kubernetes\` provider](${providerUrl}) docs, and the [Remote Kubernetes guide](${DOCS_BASE_URL}/kubernetes-plugins/remote-k8s) guide.
`,
configSchema: configSchema(),
handlers: {
Expand Down
2 changes: 1 addition & 1 deletion core/src/plugins/kubernetes/volumes/configmap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ type ConfigmapAction = DeployAction<ConfigmapActionConfig, {}>
const docs = dedent`
Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).
See the [Mounting Kubernetes ConfigMaps](${DOCS_BASE_URL}/guides/container-modules#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](${DOCS_BASE_URL}/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.
`

export const configmapDeployDefinition = (): DeployActionDefinition<ConfigmapAction> => ({
Expand Down
2 changes: 1 addition & 1 deletion core/src/util/validateInstall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ function versionCheckError(params: BinaryVersionCheckParams, msg: string, detail
deline`
${msg}
Please make sure ${params.name} (version ${params.minVersion} or later) is installed and on your PATH.
More about garden installation and requirements can be found in our documentation at https://docs.garden.io/getting-started/1-installation#requirements
More about garden installation and requirements can be found in our documentation at https://docs.garden.io/guides/installation#requirements
`,
detail
)
Expand Down
4 changes: 2 additions & 2 deletions docs/k8s-plugins/remote-k8s/configure-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ garden plugins kubernetes cluster-init

And that's it! Your Kubernetes plugin is now configured
and you can proceed to deploying your project to
Kubernetes with Garden.
Kubernetes with Garden.

If you're coming here from our [Getting Started guide](https://docs.garden.io/getting-started/0-introduction) you can now proceed with it.
If you're coming here from our [Your First Project guide](https://docs.garden.io/tutorials/your-first-project) you can now proceed with it.

Otherwise we recommend heading to the [Kubernetes Module
Types](../module-types/README.md) guide to learn how you can use
Expand Down
4 changes: 2 additions & 2 deletions docs/k8s-plugins/remote-k8s/configure-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ You can skip this step and use Garden's built-in in-cluster registry.

The in-cluster registry is a simple way to get started with Garden that requires no configuration but is not a particularly good approach for clusters with many users or lots of builds.

You can learn more in our [advanced in-cluster building guide](https://docs.garden.io/guides/in-cluster-building#configuring-a-deployment-registry).
You can learn more in our [advanced in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building#configuring-a-deployment-registry).
{% endhint %}

You'll need a container registry to be able to push and pull your container images. We typically refer to this as a **deployment registry**.

Garden needs access to the registry so that it can _push_ the images that it builds and your Kubernetes cluster needs access so that it can pull the images. This access is provided via an "image pull secret". It can be a single secret used by both or two (or more) secrets.

At the end of this step you should have a container registry set up, created an image pull secret (or secrets), and have the following values at hand:
At the end of this step you should have a container registry set up, created an image pull secret (or secrets), and have the following values at hand:

* The name of the image pull secret (or secrets).
* The name of the namespace were you created the image pull secret (or secrets).
Expand Down
2 changes: 1 addition & 1 deletion docs/k8s-plugins/remote-k8s/create-cluster/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ You can select these when creating the policy through the UI, or with this JSON
}
```

You will also need a Kubernetes role and service account in the EKS cluster. This can be achieved with the aws-auth configmap. The [instructions are documented here](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html). If you are interested in minimizing the permissions in the cluster, please take a look at our [Kubernetes RBAC guide](https://docs.garden.io/advanced/rbac-config).
You will also need a Kubernetes role and service account in the EKS cluster. This can be achieved with the aws-auth configmap. The [instructions are documented here](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html). If you are interested in minimizing the permissions in the cluster, please take a look at our [Kubernetes RBAC guide](https://docs.garden.io/kubernetes-plugins/advanced/rbac-config).
12 changes: 6 additions & 6 deletions docs/misc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,11 @@ It removes all cluster-wide Garden services.

### How do I pull a base image (using the FROM directive) from a private registry in in-cluster build mode?

See [this section](https://docs.garden.io/guides/in-cluster-building#pulling-base-images-from-private-registries) of our docs.
See [this section](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building#pulling-base-images-from-private-registries) of our docs.

### How do I use my own private registry in in-cluster build mode?

See [this section](https://docs.garden.io/guides/in-cluster-building#configuring-a-deployment-registry) of our docs.
See [this section](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building#configuring-a-deployment-registry) of our docs.

## Tasks and Tests

Expand Down Expand Up @@ -199,15 +199,15 @@ This will run the task even if the result is cached.

### How do I pass secrets to container modules?

See [this section](https://docs.garden.io/guides/container-modules#secrets) of our docs.
See [this section](https://docs.garden.io/other-plugins/container#secrets) of our docs.

### How do I mount secrets as volumes?

You'll need to use the [`kubernetes`](https://docs.garden.io/reference/module-types/kubernetes) or [`helm`](https://docs.garden.io/reference/module-types/helm) module types for that. Here's the official [Kubernetes guide](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod) for mounting secrets as files.

### Can I use Kubernetes secrets as `buildArgs`?

No, Kubernetes secrets can only be used at runtime, by referencing them in the `environment` field of `tasks`, `services` and `tests`. See [the secrets section](https://docs.garden.io/guides/container-modules#secrets) of our docs for more.
No, Kubernetes secrets can only be used at runtime, by referencing them in the `environment` field of `tasks`, `services` and `tests`. See [the secrets section](https://docs.garden.io/other-plugins/container#secrets) of our docs for more.

Also note that secrets as `buildArgs` are considered a bad practice and a security risk.

Expand All @@ -219,13 +219,13 @@ No, secrets have to be in the same namespace as the project. This is how Kuberne

### How do I mount persistent volumes?

See [this section](https://docs.garden.io/guides/container-modules#mounting-volumes) of our docs.
See [this section](https://docs.garden.io/other-plugins/container#mounting-volumes) of our docs.

### How do I access files that are generated at runtime (e.g. migration files that are checked into version control)?

You can generate the files via a task, store them as artifacts, and copy them from the local artifacts directory. [Here's an example](https://docs.garden.io/using-garden/tests#test-artifacts) of this.

You can also use the [`persistentvolumeclaim`](https://docs.garden.io/reference/module-types/persistentvolumeclaim) module type to store data and share it across modules. See [this section](https://docs.garden.io/guides/container-modules#mounting-volumes) of our docs for more.
You can also use the [`persistentvolumeclaim`](https://docs.garden.io/reference/module-types/persistentvolumeclaim) module type to store data and share it across modules. See [this section](https://docs.garden.io/other-plugins/container#mounting-volumes) of our docs for more.

## Kubernetes

Expand Down
2 changes: 1 addition & 1 deletion docs/misc/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This is a bug in Docker CE (i.e. Docker for Desktop), version `2.4.x.y`. See thi

In some container repositories, you may need to create the cache repo manually.

See [this section](https://docs.garden.io/guides/in-cluster-building#kaniko) of our docs and this [GitHub comment](https://github.com/GoogleContainerTools/kaniko/issues/410#issuecomment-433229841) for more details.
See [this section](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building#kaniko) of our docs and this [GitHub comment](https://github.com/GoogleContainerTools/kaniko/issues/410#issuecomment-433229841) for more details.

### Can't reach my services on existing ingress URLs after re-installing Garden system services.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/action-types/Deploy/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`configmap` Deploy"

Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).

See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/guides/container-modules#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our [Configuration
guide](../../../using-garden/configuration-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/action-types/Deploy/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`helm` Deploy"

Specify a Helm chart (either in your repository or remote from a registry) to deploy.

Refer to the [Helm guide](https://docs.garden.io/guides/using-helm-charts) for usage instructions.
Refer to the [Helm guide](https://docs.garden.io/kubernetes-plugins/module-types/helm) for usage instructions.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our [Configuration
guide](../../../using-garden/configuration-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/module-types/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`configmap`"

Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).

See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/guides/container-modules#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.

Below is the full schema reference. For an introduction to configuring Garden modules, please look at our [Configuration
guide](../../using-garden/configuration-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/module-types/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`helm`"

Specify a Helm chart (either in your repository or remote from a registry) to deploy.

Refer to the [Helm guide](https://docs.garden.io/guides/using-helm-charts) for usage instructions.
Refer to the [Helm guide](https://docs.garden.io/kubernetes-plugins/module-types/helm) for usage instructions.

Below is the full schema reference. For an introduction to configuring Garden modules, please look at our [Configuration
guide](../../using-garden/configuration-overview.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/providers/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ providers:
# between multiple developers, as well as between your development and CI workflows.
#
# For more details on all the different options and what makes sense to use for your setup, please check out the
# [in-cluster building guide](https://docs.garden.io/guides/in-cluster-building).
# [in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building).
buildMode: local-docker

# Configuration options for the `cluster-buildkit` build mode.
Expand Down Expand Up @@ -577,7 +577,7 @@ providers:

Choose the mechanism for building container images before deploying. By default your local Docker daemon is used, but you can set it to `cluster-buildkit` or `kaniko` to sync files to the cluster, and build container images there. This removes the need to run Docker locally, and allows you to share layer and image caches between multiple developers, as well as between your development and CI workflows.

For more details on all the different options and what makes sense to use for your setup, please check out the [in-cluster building guide](https://docs.garden.io/guides/in-cluster-building).
For more details on all the different options and what makes sense to use for your setup, please check out the [in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building).

| Type | Allowed Values | Default | Required |
| -------- | -------------------------------------------- | ---------------- | -------- |
Expand Down
Loading

0 comments on commit c5d86cc

Please sign in to comment.