Skip to content

Commit

Permalink
docs: mention cluster-init step
Browse files Browse the repository at this point in the history
  • Loading branch information
thsig authored and edvald committed Sep 11, 2019
1 parent 059eabd commit c99b6e4
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
16 changes: 15 additions & 1 deletion docs/basics/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,21 @@ git clone https://github.com/garden-io/garden.git
cd garden/examples/demo-project
```

First, let's check the environment status by running the following from the project root:
If you'd like to use a remote Kubernetes cluster, include the option `--env=remote` when invoking the `garden` commands below, or uncomment the line

```sh
defaultEnvironment: remote
```

in the project `garden.yml`.

Also, if your remote cluster hasn't previously been set up for Garden, start by running the following from the project root:

``` sh
garden plugins kubernetes cluster-init --env=remote
```

Now, let's check the environment status by running the following:

```sh
garden get status
Expand Down
18 changes: 16 additions & 2 deletions docs/examples/demo-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,23 @@ The [services](../using-garden/configuration-files.md#Services) field is specifi

## Deploying

With this configuration, Garden can now deploy our service to a local Kubernetes cluster. If this is your first time deploying this project, Garden will start by initializing the environment.
With this configuration, Garden can now deploy our service to a local Kubernetes cluster.

To deploy, run:
If you'd like to use a remote Kubernetes cluster, include the option `--env=remote` when invoking the `garden` commands below, or uncomment the line

```sh
defaultEnvironment: remote
```

in the project `garden.yml`.

Also, if your remote cluster hasn't previously been set up for Garden, start by running the following from the project root:

``` sh
garden plugins kubernetes cluster-init --env=remote
```

The first time you deploy this project, Garden will start by initializing the environment. To deploy, run:

```sh
garden deploy
Expand Down
1 change: 1 addition & 0 deletions examples/demo-project/garden.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
kind: Project
name: demo-project
# defaultEnvironment: "remote" # Uncomment if you'd like the remote environment to be the default for this project.
environments:
- name: local
providers:
Expand Down

0 comments on commit c99b6e4

Please sign in to comment.