Create new Helm chart from template¶
Ensure that your local Phalanx development environment is set up following the instructions in Setting up a Phalanx development environment.
Then, create the files for the new application, including the start of a Helm chart:
phalanx application create <application>
Replace <application>
with the name of your new application, which will double as the name of the Helm chart.
The application name must start with a lowercase letter and consist of lowercase letters, numbers, and hyphen (-
).
By default, this will create a Helm chart for a FastAPI web service created from the SQuaRE template.
Use the --starter
flag to specify a different Helm chart starter.
There are three options:
- fastapi-safir
Use this starter for FastAPI web services based on Safir, created from the “FastAPI application (Safir)” template with the “Default” flavor selected. This is the default.
- fastapi-safir-uws
Use this starter for FastAPI web services based on Safir that use UWS. These services separate the work of the service into a frontend and several backend workers, connected by a queuing system. It is used for services that have a backend that needs to run on a stack container. This starter corresponds to applications created from the “FastAPI application (Safir)” template with the “UWS” flavor selected.
- web-service
Use this starter if the new Helm application is some other web service.
- empty
Use this starter for any other type of application. This will create an empty Helm chart, to which you can add resources or external charts.
You will be prompted for a short description of the application. Keep it succinct, ideally just a few words, and do not add a period at the end. The description must begin with a capital letter.
You will also be prompted for the Argo CD project to use for your application. This must be chosen from the list of projects at Applications. See the page for each project for a short description of what it should contain.
Next steps¶
Flesh out the basic metadata for the Helm chart: Write Chart.yaml
Write the Kubernetes resource templates: Write the Kubernetes resource templates
Define the customization parameters for the chart: Write the values.yaml file
Define the secrets for your application: Define the application secrets