Using Kontena Platform

Kontena Platform is an environment for orchestrating and running containerized workloads. It provides all the required technology as a tightly integrated package.

In this chapter, we'll discover how to manage Kontena Platforms using the Kontena CLI tool:

Note! If you notice your Kontena CLI is missing sub-commands described here, you can install them with kontena plugin install cloud.

Create a New Kontena Platform

Create a new Kontena Platform for a selected organization.

$ kontena cloud platform create

Once called, you'll be prompted for a name, region and initial size. These are the required configuration options when creating a new Kontena Platform. You can also pass other configuration options when creating a new platform.

Example: Create a new platform called staging in the us-east region with the initial size set to 3:

$ kontena cloud platform create --initial-size=3 --region=us-east staging
Configuration Options (* available only on create)
  • region* - Specify the region for your Kontena Platform. You should select the region that is closest to your Kontena Nodes. If you choose a region that is very far away from your Kontena Nodes, the management APIs will become less responsive. Possible values:
    • us-east for USA
    • eu-west for Europe
  • initial-size* - Specify the initial size of your Kontena Platform. This is a required option. While it is possible to use any value here, the suggested values are: 1, 3 or 5. Please see the Initial Nodes documentation for further details.
  • supernet* - Specify the supernet used by your Kontena Platform for IPAM (IP address management). By default, this subnet is set to This option should be used if the underlying network infrastructure used by Kontena Nodes overlaps with the default supernet. See the Network Model documentation for further details.
  • subnet* - Specify the subnet used by your Kontena Platform for overlay networking. This subnet must be inside the supernet (as described above). By default, this subnet is set to Just like the supernet, this option should be used if the underlying network infrastructure used by Kontena Nodes overlaps with the default subnet. See the Network Model documentation for further details.
  • token* - Specify the Kontena Platform Grid token. The token is used for provisioning Kontena Nodes. It is also used as a shared secret for the overlay networking encryption.
  • default-affinity - Specify the default affinity rule for the entire Kontena Platform using the affinity filter syntax. The default affinity rule is applied to all Kontena Stacks on this Kontena Platform by default. The most common use case is to prevent Kontena Stack deployments to specific Kontena Nodes unless specified in Kontena Stacks.
  • no-default-affinity - Disable any previously set default affinity (as described above). Please note, changing the default affinity may trigger re-scheduling for the entire Kontena Platform.
  • statsd-server - Specify the statsd server that will listen for Kontena Statistics data. If configured, Kontena Nodes will send stats to this address using the UDP StatsD protocol. Please note:
    • The address is specified as HOST:PORT.
    • See examples and learn more about exporting Kontena Statistics here.
  • no-statsd-server - Disable any previously set statsd-server.
  • log-forwarder - Configure an external log collection service that may be used to collect logs from your Kontena Platform. Note! If you enable log forwarding, you must also set the log forwarder configuration options log-opts. Possible values include:
    • fluentd - Enable log forwarding to FluentD. See below how to configure the FluentD server with the log-opts option. See the exported tags and data structure.
    • none - Disable log forwarding
  • log-opts - Specify configuration for the log forwarder (as described above). At the moment log forwarding is only supported for FluentD. If you enable log forwarding, you need to specify the FluentD server address here using the following format: fluentd-server=<HOST>:<PORT>, where HOST is the FluentD server address and PORT is the FluentD server port. Example: enable log forwarding to FluentD kontena grid update --log-forwarder=fluentd --log-opt=fluentd-server=xyz:22445 staging

Update Kontena Platform Configuration

Your Kontena Platform configuration may be updated through the Kontena Platform Grid configuration. Therefore, use the command:

$ kontena grid update <PLATFORM_NAME>

The configuration options are the same with Kontena Platform create. See the list of supported configuration options above.

List Kontena Platforms

List all the platforms.

Example: List all the platforms in your personal account

$ kontena cloud platform list

Example: List all the platforms in the organization acme

$ kontena cloud platform list --organization acme

Switch to Another Kontena Platform

Switch context to another platform. The name of this other platform is provided as argument.

Example: Switch the platform to staging.

$ kontena cloud platform use staging

Example: Switch the platform to staging in the organization acme.

$ kontena cloud platform use acme/staging

Show Kontena Platform Configuration

Show the current platform configuration.

$ kontena cloud platform show <name>

Example: Show the platform staging

$ kontena cloud platform show staging

Example: Show the platform production in the organization acme

$ kontena cloud platform show acme/staging

Remove Kontena Platform

Remove the current platform.

$ kontena cloud platform remove <name>

Show Kontena Platform Grid Configuration

Show details of current Kontena Platform Grid.

$ kontena grid current

Bring Your Own Kontena Platform Grid

It's possible to connect a custom Kontena Platform Grid from your own Kontena Platform Master to the Kontena Cloud as a Kontena Platform. This allows you to monitor, analyze and operate your custom Kontena Platform Grid via Kontena Cloud.

To connect your Kontena Platform Grid to Kontena Cloud, use following command:

$ kontena cloud platform join [--organization=<ORGANIZATION>] <MASTER_NAME> <GRID_NAME> <PLATFORM_NAME>

Show Kontena Platform Event Logs

Show all life-cycle events.

$ kontena grid events

Show Kontena Platform Logs

Show logs from Kontena Stacks and Services.

$ kontena grid logs

Show Kontena Platform Audit Logs

Show audit logs.

$ kontena grid audit-log

Show Kontena Platform Grid Environment Details

Outputs currently used Kontena Platform Grid environment variables that can be used to configure Kontena CLI.

$ kontena grid env

Show Kontena Platform Grid Cloud-Config

Outputs cloud-config YAML that can be used as a basis for installing and joining Kontena Nodes to current Kontena Platform.

$ kontena grid cloud-config

Manage Kontena Platform Grid Trusted Subnets

If some of the Grid nodes are colocated in a trusted network (for example, within the boundary of your own datacenter) you can add subnets to a Grid's trusted subnet list. This disables data plane encryption within a trusted subnet and switches overlay to faster (near-native) mode as an optimization.

List Trusted Subnets

$ kontena grid trusted-subnet ls

Add Trusted Subnet

$ kontena grid trusted-subnet add <grid> <subnet>

Remove Trusted Subnet

$ kontena grid trusted-subnet remove <grid> <subnet>


For more information, see Kontena Cloud Platform Pricing

results matching ""

    No results matching ""