Skip to content

Commit

Permalink
docs: remove ephemeral cluster guide
Browse files Browse the repository at this point in the history
  • Loading branch information
twelvemo committed Oct 11, 2023
1 parent ee29c62 commit 1d9e73c
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 92 deletions.
2 changes: 1 addition & 1 deletion core/src/plugins/kubernetes/ephemeral/ephemeral.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const gardenPlugin = () =>
The \`${EPHEMERAL_KUBERNETES_PROVIDER_NAME}\` provider is a specialized version of the [\`kubernetes\` provider](${providerUrl}) that allows to deploy applications to one of the ephemeral Kubernetes clusters provided by Garden.
For information about using ephemeral Kubernetes clusters, please refer to [Ephemeral Kubernetes clusters guide](../../guides/ephemeral-clusters.md)
For information about using ephemeral Kubernetes clusters, please refer to [Ephemeral Kubernetes clusters guide](../../k8s-plugins/ephemeral-k8s/README.md)
`,
configSchema: configSchema(),
outputsSchema,
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@
* [2. Configure the Provider](./k8s-plugins/local-k8s/configure-provider.md)
* [Ephemeral K8s Plugin Configuration](./k8s-plugins/ephemeral-k8s/README.md)
* [1. Configure the Provider](./k8s-plugins/ephemeral-k8s/configure-provider.md)
* [2. Configure Ingress (optional)](./k8s-plugins/ephemeral-k8s/ingress.md)
* [3. Retrieve Kubeconfig (optional)](./k8s-plugins/ephemeral-k8s/retrieve-kubeconfig.md)
* [2. Login to the Garden Web Dashboard](./k8s-plugins/ephemeral-k8s/login-web-dashboard.md)
* [3. Configure Ingress (optional)](./k8s-plugins/ephemeral-k8s/ingress.md)
* [4. Retrieve Kubeconfig (optional)](./k8s-plugins/ephemeral-k8s/retrieve-kubeconfig.md)
* [Action Configuration](./k8s-plugins/action-types/README.md)
* [Container](./k8s-plugins/action-types/container.md)
* [Kubernetes](./k8s-plugins/action-types/kubernetes.md)
Expand Down Expand Up @@ -91,12 +92,11 @@
## 🌼 Guides

* [Migrating to Bonsai](./guides/migrating-to-bonsai.md)
* [Environments and namespaces](./guides/namespaces.md)
* [Code Synchronization](./guides/code-synchronization.md)
* [Connecting a local application to a Kubernetes cluster (Local Mode)](./guides/running-service-in-local-mode.md)
* [Environments and namespaces](./guides/namespaces.md)
* [Migrating from Docker Compose to Garden](./guides/migrating-from-docker-compose.md)
* [Code Synchronization](./guides/code-synchronization.md)
* [Using Garden in CI](./guides/using-garden-in-ci.md)
* [Ephemeral Kubernetes Clusters](./guides/ephemeral-clusters.md)

## 🌷 Advanced

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ git clone https://github.com/garden-io/quickstart-example.git && cd quickstart-e

### Step 3 — Deploy the project

Now we can deploy the example project to an [ephemeral Kubernetes cluster](../guides/ephemeral-clusters.md) provided by Garden.
Now we can deploy the example project to an [ephemeral Kubernetes cluster](../k8s-plugins/ephemeral-k8s/README.md) provided by Garden.

From inside the project directory, log in to the Garden web dashboard by running the log in command from the dev console:

Expand Down
79 changes: 0 additions & 79 deletions docs/guides/ephemeral-clusters.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/k8s-plugins/ephemeral-k8s/ingress.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 2. Configure Ingress (optional)
order: 2
title: 3. Configure Ingress (optional)
order: 3
---

# 2. Configure Ingress (optional)
# 3. Configure Ingress (optional)

Ephemeral Kubernetes Clusters fully support ingresses and each cluster is assigned its own unique default hostname dynamically when created. This hostname and its direct subdomains are secured by TLS and require authentication.
Garden will automatically install the nginx ingress controller for ephemeral Kubernetes. If you wish to disable it see [here](#using-your-own-ingress-controller).
Expand Down
12 changes: 12 additions & 0 deletions docs/k8s-plugins/ephemeral-k8s/login-web-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 2. Login to the Garden Web Dashboard
order: 2
---

# 2. Login to the Garden Web Dashboard

To use the ephemeral kubernetes provider you have to be logged in to the [Garden Web Dashboard](https://app.garden.io) from Garden CLI. To do so run the following command from your project root (no further configuration required):

```
garden login
```
6 changes: 4 additions & 2 deletions docs/k8s-plugins/ephemeral-k8s/retrieve-kubeconfig.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: 3. Retrieve Kubeconfig (optional)
order: 3
title: 4. Retrieve Kubeconfig (optional)
order: 4
---

# 4. Retrieve Kubeconfig (optional)

Once your ephemeral cluster is created, the kubeconfig file for that cluster is stored on your local machine. The path to the kubeconfig file is shown in the logs when you deploy your project using Garden and looks like the following:
```
kubeconfig for ephemeral cluster saved at path: /garden/examples/ephemeral-cluster-demo/.garden/ephemeral-kubernetes/<cluster-id>-kubeconfig.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers/ephemeral-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This feature is still experimental and only available in Garden `>=0.13.14`. Ple

The `ephemeral-kubernetes` provider is a specialized version of the [`kubernetes` provider](./kubernetes.md) that allows to deploy applications to one of the ephemeral Kubernetes clusters provided by Garden.

For information about using ephemeral Kubernetes clusters, please refer to [Ephemeral Kubernetes clusters guide](../../guides/ephemeral-clusters.md)
For information about using ephemeral Kubernetes clusters, please refer to [Ephemeral Kubernetes clusters guide](../../k8s-plugins/ephemeral-k8s/README.md)

Below is the full schema reference for the provider configuration. For an introduction to configuring a Garden project with providers, please look at our [configuration guide](../../using-garden/configuration-overview.md).

Expand Down

0 comments on commit 1d9e73c

Please sign in to comment.