Skip to content

Commit

Permalink
docs: fix docs base url
Browse files Browse the repository at this point in the history
  • Loading branch information
vvagaytsev committed Oct 4, 2023
1 parent 7124466 commit 66f0b1f
Show file tree
Hide file tree
Showing 21 changed files with 36 additions and 36 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -2,11 +2,11 @@
<img src="docs/logo.png" align="center">
</p>
<div align="center">
<a href="https://docs.garden.io/basics/5-min-quickstart/?utm_source=github">Quickstart</a>
<a href="https://docs.garden.io/v/acorn-0.12/basics/quickstart/?utm_source=github">Quickstart</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://garden.io/?utm_source=github">Website</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://docs.garden.io/?utm_source=github">Docs</a>
<a href="https://docs.garden.io/v/acorn-0.12/?utm_source=github">Docs</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://github.com/garden-io/garden/tree/0.12.64/examples">Examples</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
Expand Down Expand Up @@ -36,7 +36,7 @@ _If you’re using Garden or if you like the project, please ★ star this repos

### **Getting started**

The fastest way to get started with Garden is by following our [quickstart guide](https://docs.garden.io/basics/quickstart).
The fastest way to get started with Garden is by following our [quickstart guide](https://docs.garden.io/v/acorn-0.12/basics/quickstart).

### **Who should use Garden?**

Expand Down Expand Up @@ -64,7 +64,7 @@ Afterwards, the entire team benefits:

### **How does it work?**

Garden Core is a standalone binary that can run from CI or from a developer’s machine. It allows you to codify a complete description of your stack, including how it's built, deployed and tested, using the [Stack Graph](https://docs.garden.io/basics/stack-graph)—making your workflows **reproducible and portable**.
Garden Core is a standalone binary that can run from CI or from a developer’s machine. It allows you to codify a complete description of your stack, including how it's built, deployed and tested, using the [Stack Graph](https://docs.garden.io/v/acorn-0.12/basics/stack-graph)—making your workflows **reproducible and portable**.

With the Stack Graph, each part of your stack describes itself using simple, intuitive YAML declarations, without changing any of your existing code. Garden collects all of your declarations—even across multiple repositories—into a full graph of your stack.

Expand Down Expand Up @@ -92,11 +92,11 @@ garden dev

The Stack Graph is pluggable so how these actions are actually executed depends on the plugins used. Our Kubernetes plugin is currently the most popular, and chances are that’s what you’re here for. To learn more about how Garden works with Kubernetes, check out:

- [Kubernetes Plugins documentation](https://docs.garden.io/guides/remote-kubernetes).
- [Kubernetes Plugins documentation](https://docs.garden.io/v/acorn-0.12/guides/remote-kubernetes).

And for a deeper dive on how Garden works in general, we recommend:

- [This guide on how Garden works](https://docs.garden.io/basics/how-garden-works).
- [This guide on how Garden works](https://docs.garden.io/v/acorn-0.12/basics/how-garden-works).
- [This video series on the Stack Graph and getting started with Garden](https://www.youtube.com/watch?app=desktop&v=3gMJWGV0WE8).

### **Plugins**
Expand Down Expand Up @@ -136,7 +136,7 @@ We are trying to make Garden the best tool possible, and data on how it’s bein

When you use Garden, we collect information about the commands you run, the tasks being executed, the project and operating system. We care about your privacy and we take special care to anonymize all the information. For example, we hash module names, and use randomly generated IDs to identify projects.

If you are curious to see an example of the data we collect or if you would like to update your preference, please visit the [Telemetry](https://docs.garden.io/misc/telemetry) page.
If you are curious to see an example of the data we collect or if you would like to update your preference, please visit the [Telemetry](https://docs.garden.io/v/acorn-0.12/misc/telemetry) page.

### **License**

Expand Down
4 changes: 2 additions & 2 deletions docs/misc/faq.md
Expand Up @@ -9,7 +9,7 @@ title: FAQ

### How do I include multiple modules with multiple Dockerfiles in the same directory?

You will have to use the module-level [`include`](https://docs.garden.io/v/acorn-0.12/reference/module-types/container#include) directive to specify which files belong to each module. You will also have to provide the path to the Dockerfile with the [`dockerfile`](https://docs.garden.io/reference/module-types/container#dockerfile) directive.
You will have to use the module-level [`include`](https://docs.garden.io/v/acorn-0.12/reference/module-types/container#include) directive to specify which files belong to each module. You will also have to provide the path to the Dockerfile with the [`dockerfile`](https://docs.garden.io/v/acorn-0.12/reference/module-types/container#dockerfile) directive.

If the module only has a Dockerfile but no other files, say because it's a 3rd party image, you should set `include: []`.

Expand Down Expand Up @@ -229,7 +229,7 @@ See [this section](https://docs.garden.io/v/acorn-0.12/k8s-plugins/module-types/

### How do I mount secrets as volumes?

You'll need to use the [`kubernetes`](https://docs.garden.io/v/acorn-0.12/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.
You'll need to use the [`kubernetes`](https://docs.garden.io/v/acorn-0.12/reference/module-types/kubernetes) or [`helm`](https://docs.garden.io/v/acorn-0.12/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`?

Expand Down
2 changes: 1 addition & 1 deletion docs/terraform-plugin/about.md
Expand Up @@ -50,7 +50,7 @@ garden --env=<env-name> plugins terraform apply-root -- -auto-approve

### Exec Provider

One way to inject variables into new terraform manifests is to add an [exec provider](https://docs.garden.io/reference/providers/exec) that calls an [initScript](https://docs.garden.io/reference/providers/exec#providers-.initscript) in the project.garden.yaml file. Exec providers allow us to run scripts while initiating other providers. An `initScript` runs in the project root when initializing those providers.
One way to inject variables into new terraform manifests is to add an [exec provider](https://docs.garden.io/v/acorn-0.12/reference/providers/exec) that calls an [initScript](https://docs.garden.io/v/acorn-0.12/reference/providers/exec#providers-.initscript) in the project.garden.yaml file. Exec providers allow us to run scripts while initiating other providers. An `initScript` runs in the project root when initializing those providers.

In this sample `terraform/backend.tf` manifest, we need to replace the `key` based on which environment we are building.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-garden/tasks.md
Expand Up @@ -169,7 +169,7 @@ source directory instead.

### Kubernetes and Helm Modules

Because a Kubernetes or Helm module can contain any number of Kubernetes resources, a `serviceResource` needs to be specified to determine the pod spec for the task pod. You can see the whole pod spec used in the reference docs for [kubernetes](https://docs.garden.io/reference/module-types/kubernetes#tasks-.resource) and [helm modules](https://docs.garden.io/reference/module-types/helm#tasks-.resource). Please note that the `startupProbe`, `livenessProbe` and `readinessProbe` are stripped from your pod spec. Health checks for your application might fail when the container is used for testing because the main process usually running in that container is replaced by the task command.
Because a Kubernetes or Helm module can contain any number of Kubernetes resources, a `serviceResource` needs to be specified to determine the pod spec for the task pod. You can see the whole pod spec used in the reference docs for [kubernetes](https://docs.garden.io/v/acorn-0.12/reference/module-types/kubernetes#tasks-.resource) and [helm modules](https://docs.garden.io/v/acorn-0.12/reference/module-types/helm#tasks-.resource). Please note that the `startupProbe`, `livenessProbe` and `readinessProbe` are stripped from your pod spec. Health checks for your application might fail when the container is used for testing because the main process usually running in that container is replaced by the task command.

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion docs/using-garden/tests.md
Expand Up @@ -144,7 +144,7 @@ source directory instead.

### Kubernetes and Helm Modules

Because a Kubernetes or Helm module can contain any number of Kubernetes resources, a `serviceResource` needs to be specified to determine the pod spec for the test pod. You can see the whole pod spec used in the reference docs for [kubernetes](https://docs.garden.io/reference/module-types/kubernetes#tests-.resource) and [helm modules](https://docs.garden.io/reference/module-types/helm#tests-.resource). Please note that the `startupProbe`, `livenessProbe` and `readinessProbe` are stripped from your pod spec. Health checks for your application might fail when the container is used for testing because the main process usually running in that container is replaced by the test command.
Because a Kubernetes or Helm module can contain any number of Kubernetes resources, a `serviceResource` needs to be specified to determine the pod spec for the test pod. You can see the whole pod spec used in the reference docs for [kubernetes](https://docs.garden.io/v/acorn-0.12/reference/module-types/kubernetes#tests-.resource) and [helm modules](https://docs.garden.io/v/acorn-0.12/reference/module-types/helm#tests-.resource). Please note that the `startupProbe`, `livenessProbe` and `readinessProbe` are stripped from your pod spec. Health checks for your application might fail when the container is used for testing because the main process usually running in that container is replaced by the test command.

## Next Steps

Expand Down
2 changes: 1 addition & 1 deletion docs/using-garden/variables-and-templating.md
Expand Up @@ -695,7 +695,7 @@ Here the output from `prep-task` is copied to an environment variable for `my-se

For a practical use case, you might for example make a task that provisions some infrastructure or prepares some data, and then passes information about it to services.

Different module types expose different output keys for their services and tasks. Please refer to the [module type reference docs](https://docs.garden.io/reference/module-types) for details.
Different module types expose different output keys for their services and tasks. Please refer to the [module type reference docs](https://docs.garden.io/v/acorn-0.12/reference/module-types) for details.

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions examples/argocd/README.md
Expand Up @@ -48,12 +48,12 @@ helm:
```
ArgoCD image updater by default uses the same repo credential that ArgoCD would use, to commit above changes. We use a GitHub App that has been installed on the repo.

ArgoCD watches updates to the GitHub repo. Once the image tag has been updated, changes are sync'd via the [App of apps](https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/#app-of-apps-pattern) pattern.
ArgoCD watches updates to the GitHub repo. Once the image tag has been updated, changes are sync'd via the [App of apps](https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/#app-of-apps-pattern) pattern.

In the current example; A dedicated `values-prod.yaml` file has been created per service, which will be used by ArgoCD to overwrite default values and then sync to the Prod cluster.

## Setup
- To get started, set up two GKE clusters - one for development and continuous integration (Dev/CI) and another for production (Prod). Refer to our comprehensive documentation for detailed instructions on using the [remote Kubernetes plugin](https://docs.garden.io/kubernetes-plugins/remote-k8s) with Garden.io.
- To get started, set up two GKE clusters - one for development and continuous integration (Dev/CI) and another for production (Prod). Refer to our comprehensive documentation for detailed instructions on using the [remote Kubernetes plugin](https://docs.garden.io/v/acorn-0.12/kubernetes-plugins/remote-k8s) with Garden.io.
- For the __api__ and __web__ services, create repositories on Docker Hub to simplify the deployment process.
- For ease of use, we'll be using the same cluster for both the Dev and CI workloads. However, you can also choose to use separate clusters depending on your requirements.

Expand Down
2 changes: 1 addition & 1 deletion examples/base-image/README.md
Expand Up @@ -23,7 +23,7 @@ build:

This ensures that the `base-image` is built ahead of the `backend`.

We also use [build arguments](https://docs.docker.com/engine/reference/builder/#arg) in the Dockerfile and the [`garden.yml`](https://docs.garden.io/reference/module-types/container#buildargs) config so that the correct base image version is used:
We also use [build arguments](https://docs.docker.com/engine/reference/builder/#arg) in the Dockerfile and the [`garden.yml`](https://docs.garden.io/v/acorn-0.12/reference/module-types/container#buildargs) config so that the correct base image version is used:

```yaml
# In backend/garden.yml
Expand Down
2 changes: 1 addition & 1 deletion examples/build-dependencies/README.md
Expand Up @@ -11,7 +11,7 @@ Our [`openfaas` example project](../openfaas) demonstrates this same pattern wit
To achieve this, we:

1. wrap the shared files/directories in an `exec` module
2. reference it in the [build dependency](https://docs.garden.io/reference/module-types/container#build-dependencies) field of the consuming modules.
2. reference it in the [build dependency](https://docs.garden.io/v/acorn-0.12/reference/module-types/container#build-dependencies) field of the consuming modules.

## Project Structure

Expand Down
2 changes: 1 addition & 1 deletion examples/conftest/README.md
Expand Up @@ -18,4 +18,4 @@ For the example, we've copied the [kubernetes example](https://github.com/instru

To test this, simply run `garden test` in this directory. You should quickly see a few tests failing because resources don't match the policies defined under the `policy` directory.

Note that you could also manually specify tests using the [conftest module type](https://docs.garden.io/reference/module-types/conftest).
Note that you could also manually specify tests using the [conftest module type](https://docs.garden.io/v/acorn-0.12/reference/module-types/conftest).
2 changes: 1 addition & 1 deletion examples/demo-project/README.md
Expand Up @@ -2,6 +2,6 @@

A very basic demo project for Garden.

Take a look at the [getting started](https://docs.garden.io/basics/quickstart) guide to see how this project is set up.
Take a look at the [getting started](https://docs.garden.io/v/acorn-0.12/basics/quickstart) guide to see how this project is set up.

For a more advanced project check out the [vote](../vote) example project.
2 changes: 1 addition & 1 deletion examples/hadolint/README.md
@@ -1,6 +1,6 @@
# hadolint project

A simple variation on the [demo-project](../demo-project/README.md) that adds the [hadolint provider](https://docs.garden.io/reference/providers/hadolint). This generates an additional Dockerfile linting test for each `container` module in your project that contains a Dockerfile.
A simple variation on the [demo-project](../demo-project/README.md) that adds the [hadolint provider](https://docs.garden.io/v/acorn-0.12/reference/providers/hadolint). This generates an additional Dockerfile linting test for each `container` module in your project that contains a Dockerfile.

To test it, run `garden dev` in this directory, and wait for the initial processing to complete. Notice the two tests that are added and run by the `hadolint` provider.

Expand Down
4 changes: 2 additions & 2 deletions examples/istio/README.md
Expand Up @@ -28,7 +28,7 @@ cd istio-1.0.6

### Step 2 - Change default Istio port (optional)

When initializing a project that uses the `local-kubernetes` provider, Garden will install a Nginx ingress controller into the `garden-system` namespace, unless the [`setupIngressController`](https://docs.garden.io/reference/providers/local-kubernetes#project-environments-providers-setupingresscontroller) directive is set to false. In this example we have done just that:
When initializing a project that uses the `local-kubernetes` provider, Garden will install a Nginx ingress controller into the `garden-system` namespace, unless the [`setupIngressController`](https://docs.garden.io/v/acorn-0.12/reference/providers/local-kubernetes#project-environments-providers-setupingresscontroller) directive is set to false. In this example we have done just that:

```yaml
providers:
Expand Down Expand Up @@ -86,6 +86,6 @@ To verify that it works, open `http://localhost:8080/productpage` in your browse

The `details`, `productpage` and `ratings` services are Garden container modules that point to remote container images.

The `reviews` service is a [Helm module](https://docs.garden.io/reference/module-types/helm). That's because in the original Bookinfo example, the `reviews` service has three versions that each get deployed and routed to in a round robin fashion. So to stay true to the example, and because Garden doesn't currently support multiple deployments for a single service, we use the original example manifests and deploy them via the Helm plugin.
The `reviews` service is a [Helm module](https://docs.garden.io/v/acorn-0.12/reference/module-types/helm). That's because in the original Bookinfo example, the `reviews` service has three versions that each get deployed and routed to in a round robin fashion. So to stay true to the example, and because Garden doesn't currently support multiple deployments for a single service, we use the original example manifests and deploy them via the Helm plugin.

The `gateway` service is a also Helm module, that wraps the Istio Gateway. It contains the Custom Resource Definitions (CRDs) needed for Istio to handle routing for our project.
2 changes: 1 addition & 1 deletion examples/jib-container/README.md
@@ -1,6 +1,6 @@
# jib-container example

This simple example showcases the [`jib-container` module type](https://docs.garden.io/reference/module-types/jib-container), which uses [Jib](https://github.com/GoogleContainerTools/jib) to build the container images instead of a normal Docker build.
This simple example showcases the [`jib-container` module type](https://docs.garden.io/v/acorn-0.12/reference/module-types/jib-container), which uses [Jib](https://github.com/GoogleContainerTools/jib) to build the container images instead of a normal Docker build.

The example services are adapted from the examples from the [Jib repository](https://github.com/GoogleContainerTools/jib/tree/master/examples).

Expand Down
2 changes: 1 addition & 1 deletion examples/kubernetes-module/README.md
Expand Up @@ -19,4 +19,4 @@ and check that the password matches the one in the project `garden.yml` file.
## Further reading

There's not much more to it, but you can check out the module type
[reference](https://docs.garden.io/reference/module-types/kubernetes) for more details.
[reference](https://docs.garden.io/v/acorn-0.12/reference/module-types/kubernetes) for more details.
2 changes: 1 addition & 1 deletion examples/kustomize/README.md
Expand Up @@ -13,4 +13,4 @@ To run the example, simply run `garden deploy` with a local Kubernetes cluster r

## Further reading

Check out the module type [reference](https://docs.garden.io/reference/module-types/kubernetes) for more details.
Check out the module type [reference](https://docs.garden.io/v/acorn-0.12/reference/module-types/kubernetes) for more details.
4 changes: 2 additions & 2 deletions examples/local-service/README.md
Expand Up @@ -39,7 +39,7 @@ services:

In the config above the local module is always enabled when in dev mode but you can choose to conditionally enable it as well.

You could e.g. use [command line variables](https://docs.garden.io/using-garden/variables-and-templating#variable-files-varfiles) to control whether the local module should be enabled or create a custom command.
You could e.g. use [command line variables](https://docs.garden.io/v/acorn-0.12/using-garden/variables-and-templating#variable-files-varfiles) to control whether the local module should be enabled or create a custom command.

## Usage

Expand All @@ -51,7 +51,7 @@ yarn install
cd ..
```

Assuming you've [set _your_ K8s context](https://docs.garden.io/kubernetes-plugins/remote-k8s), you can start the project with:
Assuming you've [set _your_ K8s context](https://docs.garden.io/v/acorn-0.12/kubernetes-plugins/remote-k8s), you can start the project with:

```console
garden dev
Expand Down

0 comments on commit 66f0b1f

Please sign in to comment.