Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update aserto cli examples #204

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
250 changes: 0 additions & 250 deletions docs/authorizer-guide/directory-resources.mdx

This file was deleted.

14 changes: 7 additions & 7 deletions docs/command-line-interface/aserto-cli/connections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To list the connections you've established, use the following command:
## Commands

```bash
aserto tenant list-connections
aserto tenant list connections
```

There are two types of connections: system connections and user connections.
Expand All @@ -28,31 +28,31 @@ A user connection is one that the user has established between Aserto and one of
To display detailed information about a particular connection, type

```bash
aserto tenant get-connection <connection-id>
aserto tenant get connection <connection-id>
```

To verify that a connection is still operational (i.e. the token that Aserto holds is still valid), use the following command:

```bash
aserto tenant verify-connection <connection-id>
aserto tenant exec verify <connection-id>
```

To discover the types of connections Aserto supports (known as [Providers](/docs/overview/connections#providers)),
use the following:

```bash
aserto tenant list-providers
aserto tenant list providers
```

To list the kinds of providers Aserto supports, type

```bash
aserto tenant list-provider-kinds
aserto tenant list provider-kinds
```

To get more detailed information about a provider, use the following command (using the ID that
is listed in the `list-providers` results):
is listed in the `list providers` results):

```bash
aserto tenant get-provider <provider-id>
aserto tenant get provider <provider-id>
```
18 changes: 9 additions & 9 deletions docs/command-line-interface/aserto-cli/control-plane.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@ description: Using the Control Plane

Aserto [Edge Authorizers](/docs/edge-authorizers/overview) can connect to the Aserto Control Plane to receive policy and
directory updates and commands. Edge authorizers must use client certificates from Edge Authorizer connections to
connect to the Control Plane.
connect to the Control Plane.

## Configuration

The Aserto CLI can be used to configure certificates. The `list-connections` sub-command lists a tenant's existing
The Aserto CLI can be used to configure certificates. The `list connections` sub-command lists a tenant's existing
Edge Authorizer connections:

```
aserto control-plane list-connections
aserto control-plane list connections
```

Each of the listed connections has an `id` field, which can be used to retrieve certificate data, including the
certificate and private key:

```
aserto control-plane client-cert <edge-authorizer-connection-id>
aserto control-plane get certificates <edge-authorizer-connection-id>
```

For more details on how to configure the certificate see the [edge
Expand All @@ -33,7 +33,7 @@ authorizers](/docs/edge-authorizers/security-and-management) section of this doc

To list the Edge Authorizer instances connected to the Control Plane:
```
aserto control-plane list-instance-registrations
aserto control-plane list instances
```

Each entry in the resulting list will have an `id` field, a `policy-id` field indicating what policy instance the edge
Expand All @@ -43,11 +43,11 @@ environment variable, if it exists.

The `discovery` sub-command causes an Edge Authorizer to immediately fetch configuration from the Control Plane.
```
aserto control-plane discovery <instance-registration-id>
aserto control-plane exec discovery <instance-registration-id>
```

The `edge-dir-sync` sub-command causes an Edge Authorizer to immediately synchronize its local directory state (if
The `exec edge-sync` sub-command causes an Edge Authorizer to immediately synchronize its local directory state (if
synchronization is enabled).
```
aserto control-plane edge-dir-sync <instance-registration-id>
```
aserto control-plane exec edge-sync <instance-registration-id>
```
4 changes: 2 additions & 2 deletions docs/command-line-interface/aserto-cli/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ session.
## Account information

```bash
aserto tenant get-account
aserto tenant get account
```

This command returns the [organizations](/docs/overview/organization) the current account is registered with. It also returns
Expand All @@ -41,4 +41,4 @@ To sign out of the CLI, and remove the access token from your operating system's
aserto logout
```

Note: don't forget to select the configuration you want to use after the login using the `aserto config` commands.
Note: don't forget to select the configuration you want to use after the login using the `aserto config` commands.
2 changes: 1 addition & 1 deletion docs/command-line-interface/aserto-cli/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ source code provider, choosing a repository (or cloning one from a template), an
To list the policies that Aserto is managing for you, use the following command:

```bash
aserto tenant list-policy-references
aserto tenant list policy-references
```

## Policies are references
Expand Down
Loading
Loading