License resource¶

This section describes the License custom resource (CR) used in Mirantis Container Cloud API to maintain the Mirantis Container Cloud license data.

The Container Cloud License CR contains the following fields:

apiVersion
The API version of the object that is kaas.mirantis.com/v1alpha1.
kind
The object type that is License.
metadata
The metadata object field of the License resource contains the following fields:
- name
  The name of the License object, must be license.
spec
The spec object field of the License resource contains the Secret reference where license data is stored.
- license
  - secret
    The Secret reference where the license data is stored.
    
    key
    The name of a key in the license Secret data field under which the license data is stored.
    
    name
    The name of the Secret where the license data is stored.
  - value
    The value of the updated license. If you need to update the license, place it under this field. The new license data will be placed to the Secret and value will be cleaned.
status
- customerID
  The unique ID of a customer generated during the license issuance.
- instance
  The unique ID of the current Mirantis Container Cloud instance.
- dev
  The license is for development.
- limits
  The license limits for all supported cloud providers clusters except Mirantis OpenStack for Kubernetes (MOSK):
  
  clusters
  The maximum number of managed clusters to be deployed. If the field is absent, the number of deployments is unlimited.
  
  workersPerCluster
  The maximum number of workers per cluster to be created. If the field is absent, the number of workers is unlimited.
- openstack
  The license limits for MOSK clusters:
  
  clusters
  The maximum number of MOSK clusters to be deployed. If the field is absent, the number of deployments is unlimited.
  
  workersPerCluster
  The maximum number of workers per MOSK cluster to be created. If the field is absent, the number of workers is unlimited.
- expirationTime
  The license expiration time in the ISO 8601 format.
- expired
  The license expiration state. If the value is true, the license has expired. If the field is absent, the license is valid.

Configuration example of the status fields:

status:
 customerID: "auth0|5dd501e54138450d337bc356"
 instance: 7589b5c3-57c5-4e64-96a0-30467189ae2b
 dev: true
 limits:
   clusters: 3
   workersPerCluster: 5
 expirationTime: 2028-11-28T23:00:00Z