In the Project section of the
arbitrium.toml, you need to set the basic information for the CLI to work with your project.
The API token generated for your chosen environment. To generate a new API token, click here
The full path to your directory containing your
Dockerfile and all your sub directories. To build your application, you need to have the
Dockerfile at the root of this directory.
If you are using staging.edgegap.com as your testing environment, put this variable to
true otherwise, keep it to
false to manage your applications with on console.edgegap.com
In the registry part of this TOML, specify where your image will be pushed and the credentials needed. Those credentials need push and pull permissions since they will be uploaded to Arbitrium and used to deploy your application.
For more information on registry or to create a place to push your image click here
Name of your docker image (ex:
Name of the repository you want to use. From the
init command, you can specify only 3 options (docker.io, gcr.io or harbor.edgegap.net). If you are not using any of these, feel free to change it to your repository of choice here.
The password of your user or robot to push and pull your image from the repository.
The username of your user or robot to push and pull your image from the repository.
If using harbor.edgegap.net as your repository, the
Registry.User will start with
Application part of the TOML, we define what it takes to create an application.
The name of your application.
List of environment variables that your application uses.
Key of the environment variables
Value of the environment variables
If the environment variable values contains critical information put this to
list List of ports of your application version.
Name of your port, used to be easily identifiable.
Port number that your server is exposed to (ex: 80, 443, 22)
If enabled, Arbitrium will try to check if the port is open before putting your deployment.
(Beta) Enables TLS upgrade. For more information (click here)
In the Version part of the
arbitrium.toml, you will specify your application version specifications.
integer How much units of CPU your application version needs.
integer How much Memory your application needs in Megabytes
bool If your application is using a context injector. More information about context injection here
bool If your application needs to be cached in every available location. More information about caching
string Application version name. If left empty and
Versioning.SemanticVersioning = true the version name will be the versioning current version. Otherwise, it will generate a random name for you finishing with a UUID
In the Version part of the
arbitrium.toml, you can decide how an application version name is generated.
More information about semantic versioning here
bool If using semantic versioning for your application, enable it. Otherwise, update your application name each time you need to push.
string Prefix of the version name. A versioning with a prefix
v will look like:
string Suffix of the version name. A versioning with a suffix
x will look like:
integer Major release version
integer Minor release version
integer Patch release version