# openstack.container_infrastructure_management.v1.cluster_template

## The Cluster Template Class

The `ClusterTemplate` class inherits from `Resource`.

class openstack.container_infrastructure_management.v1.cluster_template.ClusterTemplate(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resources_key = 'clustertemplates'

    Plural form of key for resource.

  base_path = '/clustertemplates'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  allow_patch = True

    Allow patch operation for this resource.

  commit_method = 'PATCH'

    Method for committing a resource (PUT, PATCH, POST)

  commit_jsonpatch = True

    Whether commit uses JSON patch format.

  apiserver_port

    The exposed port of COE API server.

  cluster_distro

    Display the attribute os_distro defined as appropriate metadata in image for the bay/cluster driver.

  coe

    Specify the Container Orchestration Engine to use. Supported COEs include kubernetes, swarm, mesos.

  created_at

    The date and time when the resource was created.

  docker_storage_driver

    The name of a driver to manage the storage for the images and the container’s writable layer.

  docker_volume_size

    The size in GB for the local storage on each server for the Docker daemon to cache the images and host the containers.

  dns_nameserver

    The DNS nameserver for the servers and containers in the bay/cluster to use.

  external_network_id

    The name or network ID of a Neutron network to provide connectivity to the external internet for the bay/cluster.

  fixed_network

    The name or network ID of a Neutron network to provide connectivity to the internal network for the bay/cluster.

  fixed_subnet

    Fixed subnet that are using to allocate network address for nodes in bay/cluster.

  flavor_id

    The nova flavor ID or name for booting the node servers.

  http_proxy

    The IP address for a proxy to use when direct http access from the servers to sites on the external internet is blocked. This may happen in certain countries or enterprises, and the proxy allows the servers and containers to access these sites. The format is a URL including a port number. The default is None.

  https_proxy

    The IP address for a proxy to use when direct https access from the servers to sites on the external internet is blocked.

  image_id

    The name or UUID of the base image in Glance to boot the servers for the bay/cluster.

  insecure_registry

    The URL pointing to users’s own private insecure docker registry to deploy and run docker containers.

  is_floating_ip_enabled

    Whether enable or not using the floating IP of cloud provider.

  is_hidden

    Indicates whether the ClusterTemplate is hidden or not.

  is_master_lb_enabled

    this option can be set to false to create a bay/cluster without the load balancer.

  is_tls_disabled

    Specifying this parameter will disable TLS so that users can access the COE endpoints without a certificate.

  is_public

    Setting this flag makes the baymodel/cluster template public and accessible by other users.

  is_registry_enabled

    This option provides an alternative registry based on the Registry V2

  keypair_id

    The name of the SSH keypair to configure in the bay/cluster servers for ssh access.

  labels

    Arbitrary labels. The accepted keys and valid values are defined in the bay/cluster drivers. They are used as a way to pass additional parameters that are specific to a bay/cluster driver.

  master_flavor_id

    The flavor of the master node for this baymodel/cluster template.

  network_driver

    The name of a network driver for providing the networks for the containers.

  no_proxy

    When a proxy server is used, some sites should not go through the proxy and should be accessed normally.

  server_type

    The servers in the bay/cluster can be vm or baremetal.

  updated_at

    The date and time when the resource was updated.

  uuid

    The UUID of the cluster template.

  volume_driver

    The name of a volume driver for managing the persistent storage for the containers.

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.