Updates to documentation (#53)

* Updates to documentation - Remove mentions of Candid - Remove old defunc docs * PR comments
canonical · Jun 17, 2024 · 4d73c11 · 4d73c11
1 parent d888c49
commit 4d73c11
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 853 deletions.
diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt
@@ -5,8 +5,6 @@ APIs
 auditability
 aws
 balancer
-Candid
-Candid's
 certbot
 Charmhub
 CLI

diff --git a/explanation/jaas_security_scope.rst b/explanation/jaas_security_scope.rst
@@ -1,9 +1,6 @@
 JAAS: Security Scope
 ========================
 
-.. warning::
-    This document has not been updated for JIMM.V2.
-
 The scope of JAAS' security covers multiple aspects, including:
 
 Secure Communication
@@ -18,10 +15,10 @@ additionally acting as the IdP (Identity Provider) for said tokens.
 Access control and authentication
 ---------------------------------
 JAAS provides an abstraction layer of access control on top of Juju. JAAS does this by backing its users
-with an IdP (Identity Provider), this particular IdP is called Candid which handles the authentication 
-for JIMM (Juju Intelligent Model Manager, the back-end to JAAS). Furthermore, JAAS is  capable of many 
-authentication and authorisation types, ranging from users to agents. For authorisation, JAAS provides
-this by means of tags and ReBAC (Relation Based Access Control).
+with an IdP (Identity Provider). Various identity providers can be used for this purpose (e.g. Google or Microsoft). 
+We recommend the `Canonical identity platform`_ as the preferred IdP for JAAS. The IdP will handle user 
+authentication on behalf of JAAS using OAuth 2.0 and OIDC. For authorisation, JAAS provides this by means
+of tags and ReBAC (Relation-Based Access Control).
 
 Auditing and logging
 --------------------

diff --git a/explanation/jaas_tags.rst b/explanation/jaas_tags.rst
@@ -18,8 +18,7 @@ A user tag has the following format:
 
     user-<username>
 
-where ``username`` uniquely identifies a user including the domain specified
-by Candid.
+where ``username`` uniquely identifies a user including the domain.
 
 Group
 -----

diff --git a/how-to/deploy_jimm.rst b/how-to/deploy_jimm.rst
diff --git a/how-to/deploy_jimm_k8s.rst b/how-to/deploy_jimm_k8s.rst
diff --git a/how-to/index.rst b/how-to/index.rst
@@ -3,18 +3,6 @@ How-to guides
 
 These how-to guides cover key operations and processes in JAAS.
 
-JIMM Deployment
----------------
-
-Here are instructions on how to deploy JIMM.
-
-.. toctree::
-   :maxdepth: 1
-
-   Deploy JIMM <deploy_jimm>
-   Deploy JIMM on K8S <deploy_jimm_k8s>
-
-
 JIMM Configuration
 ------------------
 
@@ -27,7 +15,6 @@ After JIMM has been deployed, you need to configure it with your Juju operated c
    Add a controller to JIMM <add_controller>
    Migrate models to JAAS <migrate_models>
    Migrate models internally <migrate_models_internal>
-   Set up Route53 <route53>
 
 Terraform
 ---------