Documentation

MinIO Operator Console

Warning

MinIO Operator 6.0.0 deprecates and removes the Operator Console.

You can use either Kustomization or Helm to manage and deploy MinIO Tenants.

This page provides a historical view at the Operator Console, and will recieve no further updates or corrections.

The Operator Console provides a rich user interface for deploying and managing MinIO Tenants on Kubernetes infrastructure. Installing the MinIO Kubernetes Operator automatically installs and configures the Operator Console.

This page summarizes the functions available with the MinIO Operator Console.

Connect to the Operator Console

Port Forwarding

The Operator Console service does not automatically bind or expose itself for external access on the Kubernetes cluster. Instead, configure a network control plane component, such as a load balancer or ingress, to grant external access.

For testing purposes or short-term access, expose the Operator Console service through a NodePort using the following patch:

kubectl patch service -n minio-operator console -p '
{
    "spec": {
        "ports": [
            {
                "name": "http",
                "port": 9090,
                "protocol": "TCP",
                "targetPort": 9090,
                "nodePort": 30090
            },
            {
                "name": "https",
                "port": 9443,
                "protocol": "TCP",
                "targetPort": 9443,
                "nodePort": 30433
            }
        ],
        "type": "NodePort"
    }
}'

The patch command should output service/console patched. You can now access the service through ports 30433 (HTTPS) or 30090 (HTTP) on any of your Kubernetes worker nodes.

For example, a Kubernetes cluster with the following Operator nodes might be accessed at https://172.18.0.2:30443:

kubectl get nodes -o custom-columns=IP:.status.addresses[:]
IP
map[address:172.18.0.5 type:InternalIP],map[address:k3d-MINIO-agent-3 type:Hostname]
map[address:172.18.0.6 type:InternalIP],map[address:k3d-MINIO-agent-2 type:Hostname]
map[address:172.18.0.2 type:InternalIP],map[address:k3d-MINIO-server-0 type:Hostname]
map[address:172.18.0.4 type:InternalIP],map[address:k3d-MINIO-agent-1 type:Hostname]
map[address:172.18.0.3 type:InternalIP],map[address:k3d-MINIO-agent-0 type:Hostname]

Use the following command to retrieve the JWT token necessary for logging into the Operator Console:

kubectl get secret/console-sa-secret -n minio-operator -o json | jq -r '.data.token' | base64 -d

If your local host does not have the jq utility installed, you can run the kubectl part of this command (before | jq) and locate the data.token section of the output.

Tenant Management

The MinIO Operator Console supports deploying, managing, and monitoring MinIO Tenants on the Kubernetes cluster.

You can deploy a MinIO Tenant through the Operator Console.

The Operator Console automatically detects MinIO Tenants deployed on the cluster when provisioned through:

  • Operator Console

  • Helm

  • Kustomize

Select a listed tenant to open an in-browser view of that tenant’s MinIO Console. You can use this view to directly manage, modify, expand, upgrade, and delete the tenant through the Operator UI.

New in version Operator: 5.0.0

You can download a Log Report for a tenant from the Pods summary screen.

The report downloads as <tenant-name>-report.zip. The ZIP archive contains status, events, and log information for each pool on the deployment. The archive also includes a summary yaml file describing the deployment.

MinIO SUBNET users relying on the commercial license should register the MinIO tenants to their SUBNET account, which can be done through the Operator Console.

Tenant Registration

MinIO SUBNET users relying on the commercial license should register the MinIO tenants to their SUBNET account, which can be done through the Operator Console.

  1. Select the Register tab

  2. Enter the API Key

    You can obtain the key from MinIO SUBNET through the Console by selecting Get from SUBNET.

TLS Certificate Renewal

Operator 4.5.4 or later

Operator versions 4.5.4 and later automatically renew a tenant’s certificates when the duration of the certificate has reached 80% of its life.

For example, a tenant certificate was issued on January 1, 2023, and set to expire on December 31, 2023. 80% of the 1 year life of the certificate comes on day 292, or October 19, 2023. On that date, Operator automatically renews the tenant’s certificate.

Operator 4.3.3 to 4.5.3

Operator versions 4.3.3 through 4.5.3 automatically renew tenant certificates after they reach 48 hours before expiration.

For a certificate that expires on December 31, 2023, Operator renews the certificate on December 29 or December 30, within 48 of the expiration.

Operator 4.3.2 or earlier

Operator versions 4.3.2 and earlier do not automatically renew certificates. You must renew the tenant certificates on these releases separately.

Review Your MinIO License

To review which license you are using and the features available through different license options, select the License tab.

MinIO supports two licenses: AGPLv3 Open Source or a MinIO Commercial License. Subscribers to MinIO SUBNET use MinIO under a commercial license.

You can also Subscribe from the License screen.