Page cover

clusterrole

The describe clusterrole command retrieves detailed information about a specific ClusterRole in the Kubernetes cluster. This includes metadata, assigned permissions, and accessible resources across all namespaces.

Usage

cldkctl describe clusterrole [name] [flags]

Steps

Follow the steps below to run and view the result of this command:

  1. Run the following command in your terminal:

./cldkctl describe clusterrole [name]
  1. Replace [name] with the ClusterRole name you want to inspect.

  2. To view the resource name, refer to the corresponding get clusterrole section.

  3. If the resource is located in a non-default namespace, include the -n or --namespace flag followed by the namespace name.

./cldkctl describe [resource] [name] -n [namespace]
  1. Once completed successfully, the detailed information about the specified ClusterRole will appear in your terminal. This output contains metadata fields, managed fields, and permission rules.

The following table describes the additional fields specific to the ClusterRole resource.

Column
Description

rules

A list of permission rules associated with the ClusterRole.

rules.verbs

The actions that can be performed.

rules.apiGroups

The API groups these rules apply to.

rules.resource

The Kubernetes resources that these rules control access to.

Flags

  1. This command supports global flags. Refer to the Global Flags section for details.

  2. For common metadata fields, refer to the Common Output Fields table at the beginning of this section.

Flag
Descritpion

-h, --help

Help for describe clusterrole command.

Last updated