Create a new project on V3

Note

If your project already runs on V2, you should follow the migration guide instead of this guide.

Application

Firstly you need a somewhat functional web server. At a minimum it must be able to somehow return a 200 OK.

Repository

If you don't already have a GitHub repository for you project, create one.

It should live in the Iterate Organization.

Put your code here.

Dockerfile

For HOPS to build container images for your app, you need to provide a Dockerfile.

iterapp.toml

You need to provide an iterapp.toml, with the configuration for your project.

health

You need to set your application up respond to healthchecks as described in the health/readiness reference.

Register

You need to register your project with HOPS. This is done with the HOPS CLI.

CLI

Warning

When interacting with projects running on V3, you must use the v3 subcommand in the HOPS CLI.

Like hops v3 status.

Install

If you don't already have the HOPS CLI installed, install it as described in the cli howto.

Login

You need to login (again).

hops v3 login

Register

hops v3 register --cluster <CLUSTER> <owner/name>

If you don't know which <CLUSTER> to use, it is probably iterapp. And <owner/name> means GiHub-organization (iterate) and GitHub-repo (your new app).

Now what?

If the registration goes ok, you are now registered. Good job.

You can try and confirm that it really worked by heading to https://headless-operations.com and see if your project is listed there.