# role

The describe role command retrieves detailed information about a specific Role in the Kubernetes cluster. This includes the assigned permissions, accessible resources, API groups, and the allowed verbs associated with each rule.

## Usage

```
cldkctl describe role [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 role [name] 
```

2. Replace \[name] with the Role name you want to inspect.
3. To view the resource name, refer to the corresponding get role section.
4. 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]
```

5. Once completed successfully, the detailed information about the specified Role will appear in your terminal. The output includes metadata and a list of rules that define access permissions.

<figure><img src="https://2882153758-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi9YWb69HFXLHYlXffReU%2Fuploads%2FJMDSz7Y0SytJJceLRi2E%2Funknown.png?alt=media&#x26;token=935c1747-1092-480a-ad99-e7f06792378f" alt=""><figcaption></figcaption></figure>

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

| Column          | Description                                                                                                                        |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| rules           | A list of access control rules defined in the Role. Each rule specifies a set of allowed actions (verbs) on one or more resources. |
| rules.verbs     | The actions permitted by this Role.                                                                                                |
| rules.apiGroups | The API groups associated with the resources.                                                                                      |
| rules.resources | The types of Kubernetes objects this Role grants access to.                                                                        |

## Flags

{% hint style="info" %}

1. This command supports [global flags.](https://docs.cloudeka.ai/cloudeka-api-list/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.
   {% endhint %}

| Flag       | Description                     |
| ---------- | ------------------------------- |
| -h, --help | Help for describe role command. |