Iterate Locally

Get set up to develop ship applications locally

This guide moves past the “Hello World” example and walks through setting up a full end-to-end developer environment for iterating on your Ship Application.

Project Setup

The first step is to start from the Replicated Ship Starter Project and get set up with your own copy of that repo.

You’ll want to follow the steps in the Project Readme to get the make run-local and make run-local-headless tasks running properly.

Running your Application

Once you have the project set up, you should test your outputs in a real Kubernetes cluster. The easiest and fastest way to iterate is to run Docker for Desktop and use the built-in Kubernetes cluster option. GKE or other cloud-based managed clusters should also work.

You can use the following to test deploying your rendered Kubernetes Assets to the cluster:

make deploy

Iterating Quickly

As you’re editing your Kubernetes YAML in the base directory, you can run

make run-local-headless deploy

to quickly re-render your outputs and deploy them to a kubectl configured Kubernetes cluster.

Creating Releases

Once you’ve got a version of your app you like, you can promote releases with the CLI:

make release-ship

Next Steps

Now that you’re set up with a development environment, its time to deliver a private docker image.