CodeZero extension for Visual Studio Code

CodeZero provides a toolset enabling developers to close the develop/debug loop. You can run and test your code all within the local development environment that you love, but with the same context and access as though you are running within a cluster.

Quick Start

1. Install CodeZero CLI on your system (brew install c6o/tools/czctl)

2. Start CodeZero (czctl start)

3. Install the CodeZero extension for Visual Studio Code (search for codezero)

4. Open the CodeZero Panel in your VSCode window to start developing with CodeZero.

   

What can you do with CodeZero?

Once you have the extension setup, there are three primary actions you might be interested in doing:

1. Teleport into your Kubernetes cluster to communicate with in-cluster services
2. Intercept a cluster service's requests
3. Mount remote persistent volumes on your local machine

Teleport into your Kubernetes cluster

• Test local code that relies on services running in a cluster
• Resolve and communicate with remote services from your local machine/code
• Access in-cluster secrets and configuration as environment variables

Visit our docs to learn more about Teleport.

Intercept services

• Selectively route in-cluster traffic to a service running locally
• Collaborate with other developers to test changes in real-time
• No need for any NAT, firewall, or DNS configuration changes

Visit our docs to learn more about Intercept.

Mount remote persistent volumes

• Mount remote persistent volumes to your local system
• Read/write to remote volumes as if you are in a cluster
• Workloads continue operating unaffected

Visit our docs to learn more about Mount.

Step-by-step Guide

Changing Namespaces

The available resources displayed in the "Objects" pane depend on the current namespace you have selected. To change namespaces:

1. Expand your cluster in the top pane labelled "Clusters".
2. Your currently active namespace will be labelled with a red arrow.
3. Right click on any of the available namespaces.
4. Click "Set as current namespace"

Teleport as a Workload

Teleport can be run on any Workload type (Deployments, Pods, Jobs, etc).

1. Expand the "Workload" type you are interested in.
2. Right-click the workload you wish to intercept as.
3. Select "Teleport to this workload".

Intercept a Service

Intercept commands can only be performed on Kubernetes "Services", and when you start a new intercept, we will prompt you to specify a few parameters as well.

1. Expand the "Services" item in the "Objects" pane.
2. Right-click the service you would like to intercept.
3. Select "Intercept this service".
4. Choose the "Remote service port" you wish to intercept from the list of service ports. This is the port the service is configured to within the cluster.
5. Enter a "Local port" you wish to receive intercepted traffic on or just accept the default by pressing
6. Enter a header key/value pair to selectively intercept traffic or accept the default header by pressing . Only traffic with a header key/value pair that matches this value exactly will be redirected to your local machine.

Mounting a Workloads Persistent Volumes

Similar to Teleport, Mount works on any workload type. Once a workload type is chosen, CodeZero determines the appropriate workload definition to lookup a set of mounted volumes, then you must select where on your local system you want these volumes mounted.

1. Expand the "Workload" type you are interested in.
2. Right-click the workload you wish to mount volumes for.
3. Select "Mount this workload's volumes".
4. Choose a path on your local system to mount the volumes.

Closing Sessions

Once you've opened a teleport, intercept, or mount, any active CodeZero sessions will be displayed in the bottom pane (labelled "Sessions"). To close active sessions:

1. Right-click a session from the list.
2. Select "Close this session".

Managing Clusters

Currently, the CodeZero VSCode extension does now provide a mechanism to manage your systems Kubernetes clusters. Instead, we recommend you use the Kubernetes Extension to add and manage your clusters.

Learn More

If you want to learn more about how each of these features work, and what CodeZero is doing under the hood, check out:

• Our documentation
• Blog and Medium articles
• YouTube channel

Questions, issues, freature requests

If you run into any issues, need some help, or want to make some suggestions, please don't hesitate to let us know! We have a few options below for how to get in contact, or if you're more comfortable sticking to just email, feel free to reach out to Connery and our developer support team at email.

Found an Issue?

Please report any issues you come across to our GitHub Issues, and we will try to get them resolved as soon as possible.

Roadmap

Checkout our public roadmap to see what is coming down the pipe, and help us prioritize what is important to you!

Feature Requests

Open a new issue to propose a new features. We ask that you please search the existing open features first, to see if there is already an existing request for the same feature.

Data and Telemetry

To help us fix issues fast and continually improve our tools, we currently collect basic usage telemetry data and exception logs. This includes data such as: commands run, flags used, session duration, machine ID, etc.