Obtenir des informations sur un cluster

Vous pouvez obtenir des informations à propos des clusters que vous avez créés.

Obtenir des informations sur vos clusters avec Cockpit

Dans le dashboard Projets, cliquez sur le nom du projet pour lequel vous souhaitez obtenir des informations sur les clusters.
Le volet de détails du projet apparaît.
Cliquez sur l’onglet Clusters.
La liste de vos clusters apparaît.

Obtenir des informations sur vos clusters avec octl

À ce jour, cette section est disponible en anglais uniquement.

The GetCluster command gets information about a specific cluster.

Request sample

$ octl kube api GetCluster <cluster_id> --profile "default"

The GetCluster command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the API request.
Cluster: Information about the cluster.
- project_id: The ID of the project this cluster belongs to.
- id: The Universally Unique Identifier (UUID) of the cluster.
- name: A unique name for the cluster within the project.
- description: An optional description of the cluster.
  Default: .
- cp_multi_az: If true, multi-Subregion deployment is enabled for the control plane. If false, it is disabled.
- cp_subregions: The Subregions on which the control plane components are deployed.
- version: The Kubernetes version deployed for the cluster. For more information, see GetKubernetesVersions.
- expected_version: The version of Kubernetes that is expected to be deployed during maintenance.
- cni: The Container Network Interface (CNI) used in the cluster.
- admin_lbu: If true, load balancer administration is enabled for cluster management. If false, it is disabled.
- admission_flags: The configuration for Kubernetes admission controllers.
  - disable_admission_plugins: The list of Kubernetes admission plugins that are disabled.
    Default: [].
  - enable_admission_plugins: The list of Kubernetes admission plugins that are enabled.
    Default: [].
  - applied_admission_plugins: The list of admission plugins that are currently applied to the cluster.
    Default: ["CertificateApproval", "CertificateSigning", "CertificateSubjectRestriction", "ClusterTrustBundleAttest", "DefaultIngressClass", "DefaultStorageClass", "DefaultTolerationSeconds", "LimitRanger", "MutatingAdmissionWebhook", "NamespaceLifecycle", "PersistentVolumeClaimResize", "PodSecurity", "Priority", "ResourceQuota", "RuntimeClass", "ServiceAccount", "StorageObjectInUseProtection", "TaintNodesByCondition", "ValidatingAdmissionPolicy", "ValidatingAdmissionWebhook"].
- cidr_pods: The CIDR block of the Kubernetes pods' network.
- cidr_service: The CIDR block of the Kubernetes services' network.
- cluster_dns: The IP of the cluster’s DNS service.
- tags: The key/value combinations of the tags associated with the cluster, in the following format: "tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}.
  Example: {"key": "value"}.
- auto_maintenances (deprecated): The configuration for automated maintenance windows.
  - minor_upgrade_maintenance: The maintenance window configuration for minor Kubernetes upgrades.
    
    enabled: If true, a maintenance window is enabled.
    Default: true.
    
    duration_hours: The duration of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23. Default: 0.
    
    start_hour: The starting time of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23. Default: 12.
    
    week_day: The weekday on which the maintenance window begins.
    Possible values: Mon | Tue | Wed | Thu | Fri | Sat | Sun | string. Default: Tue.
    
    tz: The timezone for the maintenance window.
    Default: UTC.
  - patch_upgrade_maintenance: The maintenance window configuration for patch Kubernetes upgrades.
    
    enabled: If true, a maintenance window is enabled.
    Default: true.
    
    duration_hours: The duration of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23. Default: 0.
    
    start_hour: The starting time of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23. Default: 12.
    
    week_day: The weekday on which the maintenance window begins.
    Possible values: Mon | Tue | Wed | Thu | Fri | Sat | Sun | string. Default: Tue.
    
    tz: The timezone for the maintenance window.
    Default: UTC.
- maintenance_window: The configuration for automated maintenance windows.
  - duration_hours: The duration of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23.
  - start_hour: The starting time of the maintenance window, in hours.
    Minimum value: 0. Maximum value: 23.
  - week_day: The weekday on which the maintenance window begins.
    Possible values: Mon | Tue | Wed | Thu | Fri | Sat | Sun | string.
  - tz: The timezone for the maintenance window.
    Default: UTC.
- control_planes: The control plane sizing of the cluster.
- expected_control_planes: The type of control plane size that is expected.
- admin_whitelist: The list of CIDR blocks or IPs allowed to access the cluster via the Kubernetes API.
- statuses: The status information of the cluster.
  - created_at: The timestamp when the cluster was created.
  - deleted_at: The timestamp when the cluster was deleted (if applicable).
  - updated_at: The timestamp when the cluster was last updated.
  - status: The status of the cluster.
  - available_upgrade: Any available version of Kubernetes for upgrade (if applicable). For more information, see GetKubernetesVersions.
    Default: .
- disable_api_termination: If true, cluster deletion through the API is disabled. If false, it is enabled.
  Default: false.
- auth: The authentication strategy used to access the cluster.
  - oidc: The configuration for authenticating to the cluster using OpenID Connect (OIDC).
    
    issuer-url: The server URL of the OIDC provider, using the HTTPS protocol (https://).
    
    client-id: The client ID provided by the OIDC provider. This will be used by the cluster to connect to the server.
    
    username-claim: A JSON Web Token (JWT) claim provided by the OIDC provider. This will be used to retrieve the username on the Kubernetes side.
    
    username-prefix: A prefix added to the Kubernetes username, to prevent clashing with existing names (for example, oidc:).
    
    groups-claim: A JSON Web Token (JWT) claim provided by the OIDC provider. This will be used to retrieve the user’s group on the Kubernetes side.
    
    groups-prefix: A prefix added to the Kubernetes group, to prevent clashing with existing names (for example, oidc:).
    
    required-claim: The key/value combination of OIDC claims that must be included in the ID token for the user to authenticate. If not specified, no claim-based restrictions are enforced.
    Example: {"claim": "value"}.

Result sample

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Cluster": {
    "project_id": "string",
    "id": "string",
    "name": "string",
    "description": "",
    "cp_multi_az": true,
    "cp_subregions": [
      "string"
    ],
    "version": "string",
    "expected_version": "string",
    "cni": "string",
    "admin_lbu": true,
    "admission_flags": {
      "disable_admission_plugins": [],
      "enable_admission_plugins": [],
      "applied_admission_plugins": [
        "CertificateApproval",
        "CertificateSigning",
        "CertificateSubjectRestriction",
        "ClusterTrustBundleAttest",
        "DefaultIngressClass",
        "DefaultStorageClass",
        "DefaultTolerationSeconds",
        "LimitRanger",
        "MutatingAdmissionWebhook",
        "NamespaceLifecycle",
        "PersistentVolumeClaimResize",
        "PodSecurity",
        "Priority",
        "ResourceQuota",
        "RuntimeClass",
        "ServiceAccount",
        "StorageObjectInUseProtection",
        "TaintNodesByCondition",
        "ValidatingAdmissionPolicy",
        "ValidatingAdmissionWebhook"
      ]
    },
    "cidr_pods": "string",
    "cidr_service": "string",
    "cluster_dns": "string",
    "tags": {
      "key": "value"
    },
    "auto_maintenances": {
      "minor_upgrade_maintenance": {
        "enabled": true,
        "duration_hours": 0,
        "start_hour": 12,
        "week_day": "Mon",
        "tz": "UTC"
      },
      "patch_upgrade_maintenance": {
        "enabled": true,
        "duration_hours": 0,
        "start_hour": 12,
        "week_day": "Mon",
        "tz": "UTC"
      }
    },
    "maintenance_window": {
      "duration_hours": 23,
      "start_hour": 23,
      "week_day": "Mon",
      "tz": "UTC"
    },
    "control_planes": "string",
    "expected_control_planes": "string",
    "admin_whitelist": [
      "string"
    ],
    "statuses": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "status": "string",
      "available_upgrade": ""
    },
    "disable_api_termination": false,
    "auth": {
      "oidc": {
        "issuer-url": "string",
        "client-id": "string",
        "username-claim": "string",
        "username-prefix": "string",
        "groups-claim": [
          "string"
        ],
        "groups-prefix": "string",
        "required-claim": {
          "claim": "value"
        }
      }
    }
  }
}

Obtenir des informations sur vos clusters avec OKS CLI

Pour obtenir des informations à propos de vos clusters, utilisez la commande cluster get en suivant cette syntaxe :

Exemple de requête

$ oks-cli cluster get \
    --project-name NAME_OF_PROJECT \
    --cluster-name NAME_OF_CLUSTER

Cette commande contient les options suivantes que vous devez spécifier :

cluster-name : Le nom du cluster sur lequel vous voulez obtenir des informations.
(optionnel) project-name : Le nom du projet contenant le cluster.
(optionnel) output : Le format de sortie de la réponse (json | yaml). Par défaut, le format de la réponse est JSON.

La commande cluster get renvoie les éléments suivants :

project_id : L’ID du projet auquel appartient ce cluster.
id : Le Universally Unique Identifier (UUID) du cluster.
name : Un nom unique pour le cluster au sein du projet.
description : Une description facultative du cluster.
cp_multi_az : Si true, le déploiement multi-Sous-régions est activé pour le control plane. Si false, il est désactivé.
cp_subregions : Les Sous-régions sur lesquelles les composants du control plane sont déployés.
version : La version Kubernetes déployée pour le cluster. Pour en savoir plus, voir GetKubernetesVersions.
cni : Le Container Network Interface (CNI) utilisé dans le cluster.
admin_lbu : Si true, l’administration de load balancers est activée pour la gestion des clusters. Si false, elle est désactivée.
admission_flags : La configuration des contrôleurs d’admission Kubernetes.
- disable_admission_plugins : La liste des plugins d’admission qui sont désactivés.
- enable_admission_plugins : La liste des plugins d’admission qui sont activés.
- applied_admission_plugins : La liste des plugins d’admission qui sont actuellement appliqués au cluster.
cidr_pods : Le bloc CIDR utilisé en interne pour les pods.
cidr_service : Le bloc CIDR utilisé en interne pour les services.
cluster_dns : L’IP du service DNS du cluster.
tags : Les tags appliqués aux worker nodes du cluster.
auto_maintenances : La configuration des fenêtres de maintenance automatisées.
- minor_upgrade_maintenance : La configuration de la fenêtre de maintenance pour les mises à niveau mineures de Kubernetes.
  - enabled : Si true, une fenêtre de maintenance est activée.
  - duration_hours : La durée de la fenêtre de maintenance, en heures.
  - start_hour : L’heure de début de la fenêtre de maintenance, en heures.
  - week_day : Le jour de la semaine où commence la fenêtre de maintenance.
  - tz : Le fuseau horaire pour la fenêtre de maintenance.
- patch_upgrade_maintenance : La configuration de la fenêtre de maintenance pour les mises à jour correctives Kubernetes.
  - enabled : Si true, une fenêtre de maintenance est activée.
  - duration_hours : La durée de la fenêtre de maintenance, en heures.
  - start_hour : L’heure de début de la fenêtre de maintenance, en heures.
  - week_day : Le jour de la semaine où commence la fenêtre de maintenance.
  - tz : Le fuseau horaire pour la fenêtre de maintenance.
control_planes : La taille souhaitée du control plane.
admin_whitelist : La liste des CIDR ou IP autorisés à accéder au cluster via l’API Kubernetes.
statuses : Les informations d’état du cluster.
- created_at : La date et l’heure de création du cluster.
- deleted_at : La date et l’heure de suppression du cluster. (si applicable).
- updated_at : La date et l’heure de dernière mise à jour du cluster.
- status : L’état du cluster.
- available_upgrade : Toute version disponible de Kubernetes pour mise à jour (si applicable).
disable_api_termination : Si true, la possibilité de supprimer le cluster via l’API est désactivée. Si false, elle est activée.

Exemple de résultat

{
    "project_id": "877295ad-171c-4f9a-86c5-d45c8b2321fe",
    "id": "5e5b232c-b7de-4cc0-9296-faa006b8bd25",
    "name": "NAME_OF_CLUSTER",
    "description": "",
    "cp_multi_az": false,
    "cp_subregions": [
        "2a"
    ],
    "version": "1.32",
    "cni": "cilium",
    "admin_lbu": false,
    "admission_flags": {
        "disable_admission_plugins": [],
        "enable_admission_plugins": [],
        "applied_admission_plugins": [
            "ClusterTrustBundleAttest",
            "LimitRanger",
            "RuntimeClass",
            "ServiceAccount",
            "CertificateApproval",
            "ResourceQuota",
            "PodSecurity",
            "Priority",
            "NamespaceLifecycle",
            "DefaultIngressClass",
            "PersistentVolumeClaimResize",
            "ValidatingAdmissionPolicy",
            "StorageObjectInUseProtection",
            "CertificateSigning",
            "DefaultStorageClass",
            "MutatingAdmissionWebhook",
            "CertificateSubjectRestriction",
            "TaintNodesByCondition",
            "DefaultTolerationSeconds",
            "ValidatingAdmissionWebhook"
        ]
    },
    "cidr_pods": "10.91.0.0/16",
    "cidr_service": "10.92.0.0/16",
    "cluster_dns": "10.92.0.10",
    "tags": {},
    "auto_maintenances": {
        "minor_upgrade_maintenance": {
            "enabled": true,
            "duration_hours": 1,
            "start_hour": 12,
            "week_day": "Tue",
            "tz": "UTC"
        },
        "patch_upgrade_maintenance": {
            "enabled": true,
            "duration_hours": 1,
            "start_hour": 12,
            "week_day": "Tue",
            "tz": "UTC"
        }
    },
    "control_planes": "cp.mono.master",
    "admin_whitelist": [
        "1.2.3.4/32",
        "5.6.7.8/32"
    ],
    "statuses": {
        "created_at": "2025-01-01T00:02:00.000000Z",
        "updated_at": "2025-01-01T00:02:00.000001Z",
        "status": "pending",
        "available_upgrade": ""
    },
    "disable_api_termination": false
}

Pages connexes

Méthodes API correspondantes

GetCluster (API OKS)