Advanced installation options
When installing AxoRouter, you can set a number of advanced options if needed for your environment. Setting the advanced options in the Axoflow Console automatically updates the one-liner command that you can copy and run.
Alternatively, before running the one-liner you can use one of the following methods:
-
Set the related environment variable for the option. For example:
export AXOROUTER_USER=syslogng export AXOROUTER_GROUP=syslogng -
Set the related URL parameter for the option. For example:
curl -fLsH 'X-AXO-TOKEN:random-generated' 'https://<your-tenant-id>.cloud.axoflow.io/setup.sh?type=AXOROUTER&platform=K8S¶meter=value' | sh
Proxy settings
Use the http_proxy=, https_proxy=, no_proxy= parameters to configure HTTP proxy settings for the installer. To configure the Axolet service to use the proxy settings, enable the AXOLET_AVOID_PROXY parameter as well. Lowercase variable names are preferred because they work universally.
Installation options
You can pass the following parameters to the installation script as environment variables, or as URL parameters.
sudo would mask environment variables of the calling shell. Either start the whole procedure from a root shell, or let the install script call sudo when it needs to. In other words: don’t add the sudo command to the provisioning command.
AxoRouter image override
| Default value: | empty string |
| Environment variable | IMAGE |
| URL parameter | image |
Description: Deploy the specified AxoRouter image.
Helm chart
| Default value: | oci://us-docker.pkg.dev/axoflow-registry-prod/axoflow/charts/axorouter-syslog |
| Environment variable | HELM_CHART |
| URL parameter | helm_chart |
Description: The path or URL of the AxoRouter Helm chart.
Helm chart version
| Default value: | Current Axoflow version |
| Environment variable | HELM_CHART_VERSION |
| URL parameter | helm_chart_version |
Description: Deploy the specified version of the Helm chart.
Helm extra arguments
| Default value: | empty string |
| Environment variable | HELM_EXTRA_ARGS |
| URL parameter | helm_extra_args |
Description: Additional arguments passed to Helm during the installation.
Helm release name
| Default value: | axorouter |
| Environment variable | HELM_RELEASE_NAME |
| URL parameter | helm_release_name |
Description: Name of the Helm release.
Image repository
| Default value: | us-docker.pkg.dev/axoflow-registry-prod/axoflow/axorouter |
| Environment variable | IMAGE_REPO |
| URL parameter | image_repo |
Description: Deploy AxoRouter from a custom image repository.
Image version
| Default value: | Current Axoflow version |
| Environment variable | IMAGE_VERSION |
| URL parameter | image_version |
Description: Deploy the specified AxoRouter version.
Namespace
| Default value: | axorouter |
| Environment variable | NAMESPACE |
| URL parameter | namespace |
Description: The namespace where AxoRouter is installed.
Axolet parameters
API server host
| Default value: | |
| Environment variable | |
| URL parameter | api_server_host |
Description: Override the host part of the API endpoint for the host.
Axolet executable path
| Default value: | |
| Environment variable | AXOLET_EXECUTABLE |
| URL parameter | axolet_executable |
Description: Path to the Axolet executable.
Axolet image override
| Default value: | empty string |
| Environment variable | AXOLET_IMAGE |
| URL parameter | axolet_image |
Description: Deploy the specified Axolet image.
Axolet image repository
| Default value: | us-docker.pkg.dev/axoflow-registry-prod/axoflow/axolet |
| Environment variable | AXOLET_IMAGE_REPO |
| URL parameter | axolet_image_repo |
Description: Deploy Axolet from a custom image repository.
Axolet image version
| Default value: | Current Axoflow version |
| Environment variable | AXOLET_IMAGE_VERSION |
| URL parameter | axolet_image_version |
Description: Deploy the specified Axolet version.
Initial GUID
| Default value: | |
| Environment variable | |
| URL parameter | initial_guid |
Description: Set a static GUID.