Merge pull request #922 from run-ai/add-persona

add-persona

Author: yarongol

README.md

@@ -5,9 +5,11 @@ Welcome to the Run:ai documentation area. For an introduction about what is the
 This documentation is based on [mkdocs](https://www.mkdocs.org/). To view the library as a website go to [docs.run.ai](https://docs.run.ai). 
 
 
-The Run:ai documentation is targeting three personas:
+The Run:ai documentation is targeting four personas:
 
-* Run:ai Administrator - Responsible for the setup and the day-to-day administration of the product. Administrator documentation can be found [here](docs/admin/overview-administrator.md).
+* Infrastructure Administrator - An IT person, responsible for the installation, setup and IT maintenance of the Run:ai product. Infrastructure Administrator documentation can be found [here](docs/admin/overview-administrator.md).
+
+* Platform Administrator - Responsible for the day-to-day administration of the product. Platform Administrator documentation can be found [here](docs/admin/overview-administrator.md).
 
 * Researcher - Using Run:ai to submit jobs. Researcher documentation can be found [here](docs/Researcher/overview-researcher.md).
 

docs/Researcher/overview-researcher.md

@@ -11,5 +11,4 @@ As part of the Researcher documentation you will find:
 * __Command line interface__ reference documentation.
 * __Best Practices__ for Deep Learning with Run:ai.
 * Information about the Run:ai __Scheduler__.
-* The Run:ai Python __Researcher Library__ which you can optionally use in your container to get additional reporting and further resource optimization.
 * Using Run:ai with various __developer tools__. 

docs/admin/overview-administrator.md

@@ -1,11 +1,14 @@
-# Overview: Administrator Documentation
+# Overview: Infrastructure Administrator
 
-The role of Administrators is to set up Run:ai and perform day-to-day monitoring and maintenance.
+The Infrastructure Administrator is an IT person, responsible for the installation, setup and IT maintenance of the Run:ai product. 
 
-As part of the Administrator documentation you will find:
 
-* __Run:ai Setup__ How to set up and modify a GPU cluster with Run:ai.
-* __Researcher Setup__ How to set up Researchers to work with Run:ai.
-* How to configure __Workloads__ and Workload __Policies__.
-* Setting and maintaining the cluster via the  __Run:ai User Interface__.
-* __Troubleshooting__ Run:ai and understanding cluster health.
+As part of the Infrastructure Administrator documentation you will find:
+
+* Install Run:ai 
+    * How to set up and modify a GPU cluster with Run:ai.
+    * Set up Researchers to work with Run:ai.
+* Configure the Run:ai system
+* Setup users by connecting Run:ai to an identity provider.
+* IT maintenance of the Run:ai system
+* Troubleshooting Run:ai and understanding cluster health.

docs/index.md renamed to docs/home/overview.md

@@ -6,11 +6,15 @@ Welcome to the Run:ai documentation area. For an introduction about what is the
 
 The Run:ai documentation is targeting three personas:
 
-* Run:ai Administrator - Is responsible for the setup and the day-to-day administration of the product. Administrator documentation can be found [here](./admin/overview-administrator.md).
+The Run:ai documentation is targeting four personas:
 
-* Researcher - Using Run:ai to submit Jobs. Researcher documentation can be found [here](./Researcher/overview-researcher.md).
+* Infrastructure Administrator - An IT person, responsible for the installation, setup and IT maintenance of the Run:ai product. Infrastructure Administrator documentation can be found [here](../admin/overview-administrator.md).
 
-* Developer - Using various APIs to manipulate Jobs and integrate with other systems. Developer documentation can be found [here](./developer/overview-developer.md).
+* Platform Administrator - Responsible for the day-to-day administration of the product. Platform Administrator documentation can be found [here](../platform-admin/overview.md)).
+
+* Researcher - Using Run:ai to submit jobs. Researcher documentation can be found [here](../Researcher/overview-researcher.md).
+
+* Developer - Using various APIs to manipulate Jobs and integrate with other systems. Developer documentation can be found [here](../developer/overview-developer.md).
 
 ## How to get support
 

docs/platform-admin/overview.md

@@ -0,0 +1,13 @@
+
+
+# Overview: Platform Administrator
+
+The Platform Administrator is responsible for the day-to-day administration of the product. 
+
+As part of the Platform Administrator documentation you will find:
+
+
+* Provide the right access to system users.
+* Configure Run:ai meta-data such as Projects, Departments, Node pools etc.  
+* Setup Workload Policies and Assets
+* Analyze system performance and perform suggested actions. 

mkdocs.yml

@@ -119,9 +119,10 @@ plugins:
         'admin/admin-ui-setup/credentials-setup.md' : 'admin/workloads/credentials-setup.md'
         'admin/admin-ui-setup/templates.md' : 'admin/workloads/templates.md'
         'admin/admin-ui-setup/dashboard-analysis.md' : 'admin/performance/dashboard-analysis.md'
+        'index.md' : 'home/overview.md'
 nav:
   - Home: 
-    - 'Overview': 'index.md'
+    - 'Overview': 'home/overview.md'
     - 'System Components' : 'home/components.md'
     - 'Whats New' :
       - 'home/whats-new-2-18.md'
@@ -135,9 +136,9 @@ nav:
       - 'Hot Fixes for 2.15' : 'home/changelog/hotfixes-2-15.md'
       - 'Hot Fixes for 2.13' : 'home/changelog/hotfixes-2-13.md'
     - 'Data Privacy' : 'home/data-privacy-details.md'
-  - 'Administrator' :
+  - 'Infrastructure Administrator' :
     - 'Overview' : 'admin/overview-administrator.md'
-    - 'Run:ai Setup' : 
+    - 'Installation' : 
       - 'Installation Types' : 'admin/runai-setup/installation-types.md'
       - 'Classic (SaaS)' :
         - 'Introduction' : 'admin/runai-setup/cluster-setup/cluster-setup-intro.md'
@@ -170,33 +171,28 @@ nav:
           - 'Next Steps' : 'admin/runai-setup/self-hosted/ocp/next-steps.md'
           - 'Upgrade' : 'admin/runai-setup/self-hosted/ocp/upgrade.md'
           - 'Uninstall' : 'admin/runai-setup/self-hosted/ocp/uninstall.md'
-      - 'Configuration' : 
-        - 'Overview' : 'admin/runai-setup/config/overview.md'
-        - 'Set Node Roles' : 'admin/runai-setup/config/node-roles.md'
-        - 'Review Kubernetes Access provided to Run:ai' : 'admin/runai-setup/config/access-roles.md'
-        - 'External access to Containers' : 'admin/runai-setup/config/allow-external-access-to-containers.md'
-        - 'User Identity in Container' : 'admin/runai-setup/config/non-root-containers.md'
-        - 'Install Administrator CLI' : 'admin/runai-setup/config/cli-admin-install.md'
-        - 'Node Affinity with Cloud Node Pools' : 'admin/runai-setup/config/node-affinity-with-cloud-node-pools.md'
-        - 'Local Certificate Authority' : 'admin/runai-setup/config/org-cert.md'
-        - 'Backup & Restore' : 'admin/runai-setup/config/dr.md'
-        - 'High Availability' : 'admin/runai-setup/config/ha.md'
-        - 'Scaling' : 'admin/runai-setup/config/large-clusters.md'
-        - 'Administrator Messages' : 'admin/runai-setup/config/admin-messages.md'
-      - 'Notifications System':
-        - 'Email and System Notifications': 'admin/runai-setup/notifications/notifications.md'
-      - 'Maintenance' : 
-        - 'Node Downtime' : 'admin/runai-setup/maintenance/node-downtime.md'
-        - 'System Monitoring' : 'admin/runai-setup/maintenance/alert-monitoring.md'
-        - 'Audit Log' : 'admin/runai-setup/maintenance/audit-log.md'
-    - 'Researcher Setup' :
-      - 'Introduction' : 'admin/researcher-setup/researcher-setup-intro.md'
-      - 'Install the CLI' : 'admin/researcher-setup/cli-install.md'
-    #  - 'Registry integration': 'admin/researcher-setup/registry-integration.md'
-    #  - 'Use a Docker Registry with Credentials' : 'admin/researcher-setup/docker-registry-config.md'
+      - 'Researcher Setup' :
+        - 'Introduction' : 'admin/researcher-setup/researcher-setup-intro.md'
+        - 'Install the CLI' : 'admin/researcher-setup/cli-install.md'
+    - 'Configuration' : 
+      - 'Overview' : 'admin/runai-setup/config/overview.md'
+      - 'Set Node Roles' : 'admin/runai-setup/config/node-roles.md'
+      - 'Review Kubernetes Access provided to Run:ai' : 'admin/runai-setup/config/access-roles.md'
+      - 'External access to Containers' : 'admin/runai-setup/config/allow-external-access-to-containers.md'
+      - 'User Identity in Container' : 'admin/runai-setup/config/non-root-containers.md'
+      - 'Install Administrator CLI' : 'admin/runai-setup/config/cli-admin-install.md'
+      - 'Node Affinity with Cloud Node Pools' : 'admin/runai-setup/config/node-affinity-with-cloud-node-pools.md'
+      - 'Local Certificate Authority' : 'admin/runai-setup/config/org-cert.md'
+      - 'Backup & Restore' : 'admin/runai-setup/config/dr.md'
+      - 'High Availability' : 'admin/runai-setup/config/ha.md'
+      - 'Scaling' : 'admin/runai-setup/config/large-clusters.md'
+      - 'Email and System Notifications': 'admin/runai-setup/notifications/notifications.md'
+    - 'Maintenance' : 
+      - 'Node Downtime' : 'admin/runai-setup/maintenance/node-downtime.md'
+      - 'System Monitoring' : 'admin/runai-setup/maintenance/alert-monitoring.md'
+      - 'Audit Log' : 'admin/runai-setup/maintenance/audit-log.md'
       - 'Setup cluster wide PVC' : 'admin/researcher-setup/cluster-wide-pvc.md'
       - 'Group Nodes' : 'admin/researcher-setup/limit-to-node-group.md'
-    #  - 'Messaging setup' : 'admin/researcher-setup/email-messaging.md'
     - 'Authentication & Authorization' :
       - 'Overview' : 'admin/authentication/authentication-overview.md'
       - 'Single Sign-On' : 
@@ -208,8 +204,26 @@ nav:
       - 'Roles' : 'admin/authentication/roles.md'
       - 'Access Rules' : 'admin/authentication/accessrules.md'
       - 'Access control' : 'admin/authentication/rbac.md'
+      - 'Researcher Authentication' : 'admin/authentication/researcher-authentication.md' 
+    - 'Troubleshooting' : 
+      - 'Cluster Health' : 'admin/troubleshooting/cluster-health-check.md'
+      - 'Troubleshooting' : 'admin/troubleshooting/troubleshooting.md'
+      - 'Diagnostics' : 'admin/troubleshooting/diagnostics.md'
+  
+  - 'Platform Administrator' :
+    - 'Overview' : 'platform-admin/overview.md'
+
+    - 'Authentication & Authorization' :
+      - 'Users' : 'admin/authentication/users.md'
+      - 'Applications' : 'admin/authentication/applications.md'
+      - 'Roles' : 'admin/authentication/roles.md'
+      - 'Access Rules' : 'admin/authentication/accessrules.md'
+      - 'Access control' : 'admin/authentication/rbac.md'
       - 'Researcher Authentication' : 'admin/authentication/researcher-authentication.md'
 
+    - 'System Configuration' : 
+      - 'Administrator Messages' : 'admin/runai-setup/config/admin-messages.md'
+
     - 'Managing AI Intiatives' :
       - 'Overview' : 'admin/aiinitiatives/overview.md'
       - 'Managing your Organization' :
@@ -220,10 +234,6 @@ nav:
         - 'Nodes' : 'admin/aiinitiatives/resources/nodes.md'
       #   - 'Node Pools' : 'admin/aiinitiatives/resources/node-pools.md'
     - 'Review your performance' :
-#      - 'Overview' : 'admin/admin-ui-setup/overview.md'
-#      - 'Users' : 'admin/admin-ui-setup/admin-ui-users.md'
-#      - 'Projects' : 'admin/admin-ui-setup/project-setup.md'
-#      - 'Departments' : 'admin/admin-ui-setup/department-setup.md'
       - 'Dashboard Analysis' : 'admin/performance/dashboard-analysis.md'
     - 'Workloads' : 
       - 'admin/workloads/README.md'
@@ -237,13 +247,11 @@ nav:
       - 'Submitting Workloads' : 'admin/workloads/submitting-workloads.md'
       - 'Credentials' : 'admin/workloads/credentials-setup.md'
       - 'Templates': 'admin/workloads/templates.md'
- 
-    - 'Troubleshooting' : 
-      - 'Cluster Health' : 'admin/troubleshooting/cluster-health-check.md'
-      - 'Troubleshooting' : 'admin/troubleshooting/troubleshooting.md'
-      - 'Diagnostics' : 'admin/troubleshooting/diagnostics.md'
     - 'Best Practices' :
       - 'From Docker to Run:ai ' : 'admin/researcher-setup/docker-to-runai.md'
+
+
+
   - 'Researcher' :
     - 'Overview' : 'Researcher/overview-researcher.md'
     - 'Quickstart Guides' :