start command¶
The start command can be used to bootstrap the YAML necessary for building and deploying your app using a GitHub Workflow. The command is intended to be run at the root directory of your project.
| Argument | Required | Description |
|---|---|---|
| appname | Yes | application name (as it will be in the cluster) |
| teamname | Yes | your team's name (app will be deployed to this namespace) |
| Flag | Required | Short | Description |
|---|---|---|---|
| extras | No | -e | comma separated list of desired extras (idporten,openSearch,aad,postgres) |
| topics | No | -c | comma separated list of desired kafka topic resources |
The command will attempt to determine the type of project in the current directory by looking for files that are specific for each platform (pom.xml, go.sum, etc.). Currently supported platforms are:
- JVM with Maven
- JVM with Gradle
- Nodejs with NPM
- Nodejs with Yarn
- Golang with Make
- Python with Pip
- Python with Poetry
YAML files are then retrieved using start.nais.io and written to the current directory in the sub-folders .github and .nais.
Generated files
This command doesn't know anything about your app, and the generated YAML files are only meant to get you started. You should go through the generated files and customize them for your needs. Please see the doc for an overview of what can be done.
Created: 2022-07-08