Arbitrium TOML specifications
#
ProjectIn the Project section of the arbitrium.toml
, you need to set the basic information for the CLI to work with your project.
#
Project.ApiTokenstring
The API token generated for your chosen environment. To generate a new API token, click here
#
Project.Pathstring
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.
#
Project.Stagingbool
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
#
RegistryIn 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
#
Registry.DockerImagestring
Name of your docker image (ex: edgegap-public/tutorial
)
#
Registry.Repositorystring
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.
#
Registry.Tokenstring
The password of your user or robot to push and pull your image from the repository.
#
Registry.Userstring
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 robot$
.
#
Registry Exemple#
ApplicationIn the Application
part of the TOML, we define what it takes to create an application.
#
Application.Namestring
The name of your application.
#
Application Exemple#
Envslist
List of environment variables that your application uses.
#
[Envs].Keystring
Key of the environment variables
#
[Envs].Valuestring
Value of the environment variables
#
[Envs].Secretbool
If the environment variable values contains critical information put this to true
#
Envs Exemple#
Portslist
List of ports of your application version.
#
[Ports].Namestring
Name of your port, used to be easily identifiable.
#
[Ports].PortNumberinteger
Port number that your server is exposed to (ex: 80, 443, 22)
#
[Ports].ToCheckbool
If enabled, Arbitrium will try to check if the port is open before putting your deployment.
#
[Ports].Tlsbool
(Beta) Enables TLS upgrade. For more information (click here)
#
Port Examples#
VersionIn the Version part of the arbitrium.toml
, you will specify your application version specifications.
#
Version.Vcpuinteger
How much units of CPU your application version needs.
#
Version.Memoryinteger
How much Memory your application needs in Megabytes
#
Version.Contextbool
If your application is using a context injector. More information about context injection here
#
Version.Cachingbool
If your application needs to be cached in every available location. More information about caching
#
Version.Namestring
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
#
Version Exemple#
VersioningIn the Version part of the arbitrium.toml
, you can decide how an application version name is generated.
More information about semantic versioning here
#
Versioning.SemanticVersioningbool
If using semantic versioning for your application, enable it. Otherwise, update your application name each time you need to push.
#
Versioning.Prefixstring
Prefix of the version name. A versioning with a prefix v
will look like: v1.0.0
.
#
Versioning.Suffixstring
Suffix of the version name. A versioning with a suffix x
will look like: 1.0.0x
.
#
Versioning.Majorinteger
Major release version
#
Versioning.Minorinteger
Minor release version
#
Versioning.Patchinteger
Patch release version