cnd

command module
v0.0.0-...-1614809 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

README

Cloud Native Development (CND)

CircleCI

Cloud Native Development (CND) is about running your development flow entirely in kubernetes, avoiding the time-consuming docker build/push/pull/redeploy cycle.

CND helps you achieve this with a mix of kubernetes automation, file synching between your local file system and kubernetes and hot reloading of containers.

How does it work

This is how a standard dev environment looks like:

 

And this how it looks after converting it into a cloud native environment:

 

The cnd container duplicates the manifest of the api pod, so it is fully integrated with every Kubernetes feature.

Local changes are synched to the cnd container via syncthing. As you save locally, it will be automatically synched in your cnd container in seconds.

Once you're ready to integrate, you can revert back to your original configuration for general end-to-end testing before sending a PR or pushing to production.

Homebrew install

brew tap okteto/cnd
brew install cnd

Manual install

The synching functionality of cnd is provided by syncthing.

To install syncthing, download the corresponding binary from their releases page.

cnd assumes that synchting is in the path, to verify, run the following:

which syncthing

Install cnd from by executing:

go get github.com/okteto/cnd

Usage

Note: these instructions assume that you already have a kubernetes-based application running.

Define your Cloud Native Development file (cnd.yml). A cnd.yml looks like this:

swap:
  deployment:
    file: nginx-deployment.yml
    container: nginx
    image: ubuntu
mount:
  source: .
  target: /src

For more information about the Cloud Native Development file, see its reference.

To convert your dev environment to a cloud native environment, execute:

cnd up

by default, it uses a cnd.yml in your current folder. For using a different file, execute:

cnd up -f path-to-cnd-file

To create a long-running session to your cloud native environment, execute:

cnd exec sh

You can also execute standalone commands like:

cnd exec go test

In order to revert back to your original configuration, execute:

cnd down

For a full demo of Cloud Native Development, check the Voting App demo.

Troubleshooting

Files are not syncing

cnd uses syncthing to sync files between your environments. If your cloud native environment is not being updated correctly, review the following:

  1. The cnd up process is running
  2. Verify that syncthing is running on your environment (there should be two processes per cnd environment running)
  3. Rerun cnd up (give it a few minutes to reestablish synchronization)
Files syncing is slow

Please follow syncthing's docs to troubleshoot this.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL