Skip to content

Commit c008ec7

Browse files
committed
docs: update htg and ref landing pages
1 parent 33859bb commit c008ec7

File tree

11 files changed

+63
-66
lines changed

11 files changed

+63
-66
lines changed

explanation/cli_tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Understanding `juju` vs `jaas` vs `jimmctl`
1+
# `juju` vs. `jaas` vs. `jimmctl`
22

33
This document aims to explain the differences between the various CLI tools you may encounter when using Juju and JAAS.
44

howto/index.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,54 @@
33

44
These how-to guides cover key operations and processes in JAAS.
55

6+
<!--
67
```{toctree}
78
:titlesonly:
89
:glob:
910
1011
*
1112
```
13+
-->
1214

13-
14-
<!--
15-
## Configuration
16-
17-
After JAAS has been deployed, you need to configure it with your Juju operated cluster.
18-
19-
```{toctree}
20-
:maxdepth: 2
21-
22-
Bootstrap permissions <bootstrap_permissions>
23-
Add a controller to JAAS <add_controller>
24-
Migrate models to JAAS <migrate_models>
25-
Migrate models internally <migrate_models_internal>
26-
Use Terraform for configuration <use_terraform>
27-
```
28-
29-
## Observability
15+
## Your JAAS deployment, the bird's eye
3016

3117
```{toctree}
32-
:maxdepth: 2
18+
:titlesonly:
19+
:glob:
3320
34-
Integrate with the Canonical Observability Stack <integrate_with_cos>
21+
manage-your-jaas-deployment
3522
```
3623

37-
## Security
24+
## Juju in JAAS
3825

3926
```{toctree}
40-
:maxdepth: 2
27+
:titlesonly:
28+
:glob:
4129
42-
Harden JIMM deployment <security_hardening>
43-
Set up Ingress with TLS <setup_ingress_with_tls>
30+
manage-juju-controllers
31+
manage-clouds
32+
manage-models
33+
manage-offers
4434
```
4535

46-
## Juju Dashboard
36+
## Authorization with JAAS
4737

4838
```{toctree}
49-
:maxdepth: 2
39+
:titlesonly:
40+
:glob:
5041
51-
Set up Juju Dashboard <setup_dashboard>
42+
manage-users
43+
manage-service-accounts
44+
manage-roles
45+
manage-groups
46+
manage-relations
5247
```
5348

54-
## Access
49+
## JAAS with Terraform
5550

5651
```{toctree}
57-
:maxdepth: 2
52+
:titlesonly:
53+
:glob:
5854
59-
Set up new users <setup_new_users>
60-
```
61-
-->
55+
use_terraform
56+
```

howto/manage-service-accounts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(manage-service-accounts)=
22
# Manage service accounts
3-
<!-->> See also: {ref}`service account`-->
3+
> See also: {ref}`service-account`
44
55
(manage-a-service-accounts-relation-to-an-entity)=
66
## Manage a service account's relation to an entity

redirects.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ reference/jaas/security_hardening/ reference/jaas/security/
4444
reference/jaas/jaas_architecture/ reference/jaas/jaas-architecture/
4545
reference/jaas/security/ reference/jaas/jaas-security/
4646
reference/jaas/supported-juju-versions/ reference/jaas/jaas-supported-juju-versions/
47+
reference/audit_logs/ reference/jimmctl-audit-events

reference/index.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,44 @@
66
```{toctree}
77
:titlesonly:
88
:glob:
9+
:hidden:
910
1011
*
1112
```
1213

13-
<!--
14+
## JAAS at a glance
1415

15-
## Security
16+
- {ref}`jaas`
17+
- {ref}`jaas-architecture`
18+
- {ref}`jaas-authentication`
19+
- {ref}`jaas-authorization`
20+
- {ref}`jaas-rebac-admin-backend`
21+
- {ref}`jaas-security-scope`
22+
- {ref}`jaas-security-overview`
23+
- {ref}`jaas-supported-juju-versions`
1624

17-
```{toctree}
18-
:maxdepth: 1
19-
20-
JAAS Security <security>
21-
Audit Logs <audit_logs>
22-
```
2325

24-
## Authorisation
26+
## JAAS Entities
2527

26-
```{toctree}
27-
:maxdepth: 1
28+
Items marked with an asterisk are Juju entities enhanced in JAAS. <br>
29+
Unmarked items are JAAS-specific.
2830

29-
Authorisation Model <authorisation_model>
30-
Authorisation Data <authorisation_data>
31-
ReBAC Admin Backend <rebac_admin_backend>
32-
```
31+
- {ref}`cloud`*
32+
- {ref}`controller`*
33+
- {ref}`group`
34+
- {ref}`model`*
35+
- {ref}`offer`*
36+
- {ref}`relation`
37+
- {ref}`role`
38+
- {ref}`service-account`
39+
- {ref}`tag`
40+
- {ref}`user`*
3341

34-
## Support
42+
## JAAS Tools
3543

3644
```{toctree}
37-
:maxdepth: 1
38-
39-
Supported Juju versions <juju_required_version>
40-
```
41-
42-
## CLI Reference
43-
44-
```{toctree}
45-
:maxdepth: 1
45+
:titlesonly:
4646
47-
jimmctl CLI reference <jimmctl>
47+
jimmctl
48+
jimmctl-audit-events
4849
```
49-
-->

reference/jaas/jaas-rebac-admin-backend.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(jaas-rebac-admin-backend)=
12
# ReBAC admin backend
23

34
The ReBAC Admin API is a REST API that provides various endpoints to query or

reference/jaas/jaas-security-scope.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Security Scope
1+
(jaas-security-scope)=
2+
# Security scope
23

34
<!-- TODO (Kian):
45
Much of this document's content is now covered in the security doc in reference/security and reused where possible.

reference/jaas/jaas-security.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(jaas-security-overview)=
12
# Security overview
23

34
This document provides an overview of JAAS security measures, focusing on areas related to

reference/jaas/jaas-supported-juju-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(supported-juju-versions)=
1+
(jaas-supported-juju-versions)=
22
# Supported Juju versions
33

44
The following sections describe which version of the Juju CLI or controller is required for different scenarios.

reference/audit_logs.md renamed to reference/jimmctl-audit-events.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# JAAS: Understanding Audit Logs
2-
3-
## Introduction
1+
# `jimmctl audit-events` details
42

53
JIMM provides audit logging functionality, tracking all requests/responses into the system.
64
This gives administrators of JIMM the ability to audit changes at a very granular level.

0 commit comments

Comments
 (0)