Workspace Cluster

User workspaces are deploying with an ephemeral, namespaced Kubernetes cluster. If you need to interact with this cluster...

If you prefer video from, click here for a 5min video!

From Anywhere

To view the config, run

dz workspace kubeconfig <workspace-name>

# to get the workspace name
dz workspace ls

To write the config to the default Kubernetes configuration location, run

dz workspace kubeconfig <workspace-name> --update-kubeconfig

Then run commands like

kubectl get pods

From Inside a DevBox

When inside a DevBox context (i.e. when connected to a workspace), the CLI is able to retrieve environmental information from /etc/devzero.

In a fresh new workspace, you can immediately run:

kubectl get pods

DevZero reserves the default namespace for it's managed deployments. Do not operate on this namespace. Adding or removing resources in this namespace will lead to undocumented behaviors and cause potential data loss.

dz workspace kubeconfig -h
This kubeconfig can be used by any kubectl to interact with the virtual cluster backing a workspace.
Usage: kubectl --kubeconfig <(dz ws kubeconfig <workspace_id | workspace_name>) ...

Usage:
  dz workspace kubeconfig <workspace_id | workspace_name> [flags]

Aliases:
  kubeconfig, kc

Flags:
  -h, --help                help for kubeconfig
  -u, --update-kubeconfig   update local kubeconfig (default: $HOME/.kube/config)

Global Flags:
      --verbose   Get detailed output

Tutorial Video

Here's a video covering how you can access and deploy apps to your workspace's Kubernetes cluster...

Tutorial Steps

1. Create a recipe that you can use at devzero.io/dashboard/recipes/new (give it any name and leave everything else blank and click Create a recipe).

2. Use the following recipe, then Save and Build and then Publish once the build completes successfully (it uses Google Cloud Platform's microservices-demo repo).

version: "3"
build:
  steps:
    - type: apt-get
      packages: ["apt-transport-https", "build-essential", "ca-certificates", "curl", "git", "nano", "software-properties-common", "ssh", "sudo", "tar", "unzip", "vim", "wget", "zip"]
    - type: git-clone
      url: https://github.com/GoogleCloudPlatform/microservices-demo
    - type: command
      command: |
        curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
        sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl && rm kubectl
    - type: command
      command: |
        curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64 && \
        sudo install skaffold /usr/local/bin/
    - type: apt-get
      packages: ["docker-ce", "docker-ce-cli", "containerd.io"]
      extra_repositories:
        - key_url: https://download.docker.com/linux/ubuntu/gpg
          repository: https://download.docker.com/linux/ubuntu
          components: []
          distribution: ""
    - type: command
      command: |
        usermod -aG docker devzero
        systemctl enable docker.service
        systemctl enable containerd.service
      user: root

3. Build a workspace from the recipe, and run the following in your terminal:

dz workspace connect <workspace-name>

4. Run the following steps inside the SSH session that's connected to your workspace:

kubectl get pods  # verification

cd /home/devzero/microservices-demo
skaffold run --default-repo ttl.sh  # this will take a bit of time since its building multiple docker images (~5mins)

5. Verify that all the pods are running:

kubectl get pods

6. Port forward the frontend to your terminal session

kubectl port-forward --address 0.0.0.0 deployment/frontend 8088:8080

7. Visit, <workspace-name>:8088 in your browser to see the app!