Skip to content

Commit 7f6a68a

Browse files
committed
docs: add entity rel sec, incorporate remaining autho content into relation ref
1 parent 1cbeb91 commit 7f6a68a

File tree

14 files changed

+210
-150
lines changed

14 files changed

+210
-150
lines changed

howto/manage-relations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
(add-a-relation)=
66
## Add a relation
77

8-
Given two entities A and B, to add a relation between run the `auth relation add` command followed by the tag of A, the access level you want to give A from the list supported by B, and the tag of B. For example, to add a relation where you make user `[email protected]` a `member` of the `mygroup` group:
8+
Given two entities A and B, to add a relation between them run the `auth relation add` command followed by the tag of A, the desired B relation, and the tag of B. For example, to add a relation where you make user `[email protected]` a `member` of the `mygroup` group:
99

1010
```text
1111
jimmctl auth relation add [email protected] member group-mygroup
@@ -20,7 +20,7 @@ jimmctl auth relation add [email protected] member group-mygroup
2020
(verify-a-relation)=
2121
## Verify a relation
2222

23-
Given two entities A and B, to verify that there is a relation between them with a specific access level, run the `auth relation check` command followed by the tag of A, the access level, and the tag of B. For example:
23+
Given two entities A and B, to verify that there is a specific relation between them, run the `auth relation check` command followed by the tag of A, the relation, and the tag of B. For example:
2424

2525
```text
2626
jimmctl auth relation check [email protected] administrator controller-aws-controller-1
@@ -43,7 +43,7 @@ jimmctl auth relation list [options]
4343
(remove-a-relation)=
4444
## Remove a relation
4545

46-
Given two entities A and B and a pre-existing relation between them, to remove the relation, run the `auth relation remove` command followed by the tag of A, the access level that A has to B, and the tag of B. For example:
46+
Given two entities A and B and a pre-existing relation between them, to remove the relation, run the `auth relation remove` command followed by the tag of A, the relation, and the tag of B. For example:
4747

4848
```text
4949
jimmctl auth relation remove [email protected] member group-mygroup

redirects.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,6 @@ howto/add_controller/ howto/manage-juju-controllers/
3131
howto/setup_ingress_with_tls/ howto/manage-jimm-controllers/
3232
howto/setup_dashboard/ howto/manage-jimm-controllers/
3333
howto/bootstrap_permissions/ howto/manage-jimm-controllers/
34-
reference/jaas/authorisation_data/ reference/relation/
34+
reference/jaas/authorisation_data/ reference/relation/
35+
reference/jaas/authorisation_model/ reference/relation/
36+
reference/jaas/authorisation/ reference/jaas/relation/

reference/cloud.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,20 @@ A cloud tag has the following format:
1313
cloud-<cloud name>
1414
```
1515

16+
(cloud-relation)=
17+
## Cloud relation
18+
19+
A cloud relation is a {ref}`relation <relation>` that describes permissions on a cloud.
20+
1621
(list-of-cloud-relations)=
17-
## List of cloud relations
18-
> See first: {ref}`relation`
22+
### List of cloud relations
1923

2024
(cloud-relation-administrator)=
21-
### `administrator`
25+
#### `administrator`
2226

2327
Abilities: Can do anything that it is possible to do at the level of a cloud.
2428

2529
(cloud-relation-can-addmodel)=
26-
### `can_addmodel`
30+
#### `can_addmodel`
2731

2832
Abilities: Can add a model and grant another user model-level permissions.

reference/controller.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,21 @@ A controller tag has the following format:
1414
controller-<controller name>
1515
```
1616

17+
(controller-relation)=
18+
## Controller relation
19+
20+
A controller relation is a {ref}`relation <relation>` that describes permissions on a controller.
21+
1722
(list-of-controller-relations)=
18-
## List of controller relations
23+
### List of controller relations
1924
> See first: {ref}`relation`
2025
2126
(controller-relation-administrator)=
22-
### `administrator`
27+
#### `administrator`
2328

2429
Abilities: Can do anything that it is possible to do at the level of a controller. This grants permissions to all resources that inherit from controller access.
2530

2631
(controller-relation-audit-log-viewer)=
27-
### `audit_log_viewer`
32+
#### `audit_log_viewer`
2833

2934
Abilities: Can read audit logs.

reference/group.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@ group-<group id>
1717

1818
where `group id` represents the unique identifier of the group.
1919

20+
(group-relation)=
21+
## Group relation
22+
23+
A group relation is a {ref}`relation <relation>` that describes permissions on a group.
2024

2125
(list-of-group-relations)=
22-
## List of group relations
23-
> See first: {ref}`relation`
26+
### List of group relations
2427

2528
(group-relation-member)=
26-
### `member`
29+
#### `member`
2730

2831
Abilities: Shares the group's access level to Juju resources and JIMM logs.
2932

-84.8 KB
Binary file not shown.

reference/jaas/authorisation.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

reference/jaas/authorisation_model.md

Lines changed: 0 additions & 82 deletions
This file was deleted.

reference/model.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,25 @@ model-<controller name>/<model name>
1515
where `<controller name>` specifies name of the controller on which the model
1616
is running and `<model name>` specifies the name of the model.
1717

18+
(model-relation)=
19+
## Model relation
20+
21+
A model relation is a {ref}`relation <relation>` that describes permissions on a model.
22+
1823
(list-of-model-relations)=
19-
## List of model relations
20-
> See first: {ref}`relation`
24+
### List of model relations
2125

2226
(model-relation-reader)=
23-
### `reader`
27+
#### `reader`
2428

2529
Abilities: Can view the content of a model without changing it. Can use any of the read commands.
2630

2731
(model-relation-writer)=
28-
### `writer`
32+
#### `writer`
2933

3034
Abilities: Can deploy and manage applications on the model.
3135

3236
(model-relation-administrator)=
33-
### `administrator`
37+
#### `administrator`
3438

3539
Abilities: Can do anything that it is possible to do at the level of a model.This grants permissions to all resources that inherit from model access.

reference/offer.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ where `<controller name>` specifies name of the controller on which the model
1818
is running, `<model name>` specifies name of the model in which the application
1919
offer was created and `<offer name>` specifies the name of the application offer.
2020

21+
(offer-relation)=
22+
## Offer relation
23+
24+
An offer relation is a {ref}`relation <relation>` that describes permissions on a offer.
2125

2226
(list-of-offer-relations)=
2327
## List of offer relations
24-
> See first: {ref}`relation`
2528

2629
(offer-relation-administrator)=
2730
### `administrator`

0 commit comments

Comments
 (0)