> For the complete documentation index, see [llms.txt](https://docs.apolo.us/index/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apolo.us/index/apolo-cli/commands/vcluster.md).

# vcluster

Operations with virtual kubernetes clusters

## Usage

```bash
apolo vcluster [OPTIONS] COMMAND [ARGS]...
```

Operations with virtual kubernetes clusters.

**Commands:**

| Usage                                                       | Description                           |
| ----------------------------------------------------------- | ------------------------------------- |
| [*activate-service-account*](#activate-service-account)     | Activate kubernetes service account   |
| [*create-service-account*](#create-service-account)         | Create kubernetes service account     |
| [*delete-service-account*](#delete-service-account)         | Delete kubernetes service account     |
| [*list-service-accounts*](#list-service-accounts)           | List kubernetes service accounts      |
| [*regenerate-service-account*](#regenerate-service-account) | Regenerate kubernetes service account |

### activate-service-account

Activate kubernetes service account

#### Usage

```bash
apolo vcluster activate-service-account [OPTIONS] NAME
```

Activate kubernetes service account

#### Options

| Name                | Description                                                   |
| ------------------- | ------------------------------------------------------------- |
| *--help*            | Show this message and exit.                                   |
| *--cluster CLUSTER* | Look on a specified cluster (the current cluster by default). |
| *--org ORG*         | Look on a specified org (the current org by default).         |
| *--project PROJECT* | Look on a specified project (the current project by default). |

### create-service-account

Create kubernetes service account

#### Usage

```bash
apolo vcluster create-service-account [OPTIONS] NAME
```

Create kubernetes service account

#### Options

| Name                | Description                                                               |
| ------------------- | ------------------------------------------------------------------------- |
| *--help*            | Show this message and exit.                                               |
| *--cluster CLUSTER* | Look on a specified cluster (the current cluster by default).             |
| *--org ORG*         | Look on a specified org (the current org by default).                     |
| *--project PROJECT* | Look on a specified project (the current project by default).             |
| *--ttl TTL*         | Expiration time in the format '1y2m3d4h5m6s' (some parts may be missing). |

### delete-service-account

Delete kubernetes service account

#### Usage

```bash
apolo vcluster delete-service-account [OPTIONS] NAME
```

Delete kubernetes service account

#### Options

| Name                | Description                                                   |
| ------------------- | ------------------------------------------------------------- |
| *--help*            | Show this message and exit.                                   |
| *--cluster CLUSTER* | Look on a specified cluster (the current cluster by default). |
| *--org ORG*         | Look on a specified org (the current org by default).         |
| *--project PROJECT* | Look on a specified project (the current project by default). |

### list-service-accounts

List kubernetes service accounts

#### Usage

```bash
apolo vcluster list-service-accounts [OPTIONS]
```

List kubernetes service accounts

#### Options

| Name                | Description                                                   |
| ------------------- | ------------------------------------------------------------- |
| *--help*            | Show this message and exit.                                   |
| *--all-users*       | Show accounts for all project users.                          |
| *--cluster CLUSTER* | Look on a specified cluster (the current cluster by default). |
| *--long-format*     | Output all info about service accounts.                       |
| *--org ORG*         | Look on a specified org (the current org by default).         |
| *--project PROJECT* | Look on a specified project (the current project by default). |

### regenerate-service-account

Regenerate kubernetes service account

#### Usage

```bash
apolo vcluster regenerate-service-account [OPTIONS] NAME
```

Regenerate kubernetes service account

#### Options

| Name                | Description                                                               |
| ------------------- | ------------------------------------------------------------------------- |
| *--help*            | Show this message and exit.                                               |
| *--cluster CLUSTER* | Look on a specified cluster (the current cluster by default).             |
| *--org ORG*         | Look on a specified org (the current org by default).                     |
| *--project PROJECT* | Look on a specified project (the current project by default).             |
| *--ttl TTL*         | Expiration time in the format '1y2m3d4h5m6s' (some parts may be missing). |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.apolo.us/index/apolo-cli/commands/vcluster.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
