doc: restricted & provision on worker models (#2510)

Signed-off-by: Yvonnick Esnault <[email protected]>

Author: yesnault

docs/content/workflows/pipelines/requirements/worker-model/_index.md

@@ -13,11 +13,38 @@ The goal of a worker model is to describe the capabilities of a given docker/iso
 
 ### Types
 
-There are 2 types of worker models:
+There are 3 types of worker models:
 
  * Docker images, see [how to create a worker model docker]({{< relref "workflows/pipelines/requirements/worker-model/docker/_index.md" >}})
  * Openstack images, see [how to create a worker model openstack]({{< relref "workflows/pipelines/requirements/worker-model/openstack.md" >}})
+ * VSphere images, see [how to create a worker model VSphere]({{< relref "workflows/pipelines/requirements/worker-model/vshpere.md" >}})
 
 ### Behavior
 
 All registered CDS [hatcheries]({{< relref "hatchery/_index.md" >}}) start/kill workers as needed.
+
+### Add a worker model
+
+![Add a worker model](/images/workflows.pipelines.requirements.docker.worker-model.add.png)
+
+A user can add a worker model by setting a owner group if user is administrator of group.
+
+A CDS administrator can add a worker model, attach it to 'shared.infra' group and set provision as he want.
+
+### What's a restricted worker model?
+
+A `shared.infra` hatchery can launch all worker models, except 'restricted' worker models.
+
+**Use case**: users can launch their own [hatchery]({{< relref "hatchery/_index.md" >}}). 
+To use their worker models only with their hatchery, they have to set worker model as 'restricted'.
+
+### What's workers provisioning?
+
+A [hatchery]({{< relref "hatchery/_index.md" >}}) can start workers based on worker models with provisioning > 0.
+
+On 'restricted' worker models, users can set provisioning, as they launch CDS Workers on their infrastructure.
+
+Otherwise, provisioning is only editable by CDS Administrators.
+
+**Notice**: if you use [Service Requirement]({{< relref "/workflows/pipelines/requirements/service/_index.md" >}}), you can't
+use provisioned workers.

docs/static/images/workflows.pipelines.requirements.docker.worker-model.add.png

@@ -26,7 +26,7 @@ <h2 *ngIf="!workerModel || !workerModel.id">{{ 'worker_model_new_title' | transl
                 <label>{{'worker_model_restricted' | translate}}</label>
                 <div class="ui checkbox">
                     <input type="checkbox" id="restricted" name="restricted" [(ngModel)]="workerModel.restricted" [disabled]="loading">
-                    <label for="restricted">{{'worker_model_restricted_help' | translate}}</label>
+                    <label for="restricted">{{'worker_model_restricted_help' | translate}} <a target="_blank" href="https://ovh.github.io/cds/workflows/pipelines/requirements/worker-model/#what-s-a-restricted-worker-model">{{'common_see_documentation' | translate}}</a></label>
                 </div>
               </div>
               <div class="field">

ui/src/app/views/settings/worker-model/add/worker-model.add.html

@@ -26,7 +26,7 @@ <h2 *ngIf="workerModel && workerModel.id">{{ 'worker_model_edit_title' | transla
                   <label>{{'worker_model_restricted' | translate}}</label>
                   <div class="ui checkbox">
                       <input type="checkbox" id="restricted" name="restricted" [(ngModel)]="workerModel.restricted" [disabled]="loading">
-                      <label for="restricted">{{'worker_model_restricted_help' | translate}}</label>
+                      <label for="restricted">{{'worker_model_restricted_help' | translate}} <a target="_blank" href="https://ovh.github.io/cds/workflows/pipelines/requirements/worker-model/#what-s-a-restricted-worker-model">{{'common_see_documentation' | translate}}</a></label>
                   </div>
               </div>
               <div class="field">

ui/src/app/views/settings/worker-model/edit/worker-model.edit.html

@@ -164,6 +164,7 @@
   "common_date_start": "Start",
   "common_description": "Description",
   "common_disabled_f": "Disabled",
+  "common_see_documentation": "See documentation",
   "common_documentation": "Documentation",
   "common_cds_documentation": "CDS Documentation",
   "common_download": "Download",

ui/src/assets/i18n/en.json

@@ -164,6 +164,7 @@
   "common_date_start": "Date de début",
   "common_description": "Description",
   "common_disabled_f": "Désactivée",
+  "common_see_documentation": "Voir documentation",
   "common_documentation": "Documentation",
   "common_cds_documentation": "Documentation CDS",
   "common_download": "Télécharger",
@@ -683,7 +684,7 @@
   "worker_model_none": "Aucun modèle de worker",
   "worker_model_provision": "Provision de workers",
   "worker_model_restricted": "Restreint",
-  "worker_model_restricted_help": "Ne peut être utilisé que par une hatchery utilisateur - cocher si oui",
+  "worker_model_restricted_help": "Ne peut être utilisé que par une hatchery utilisateur - cocher si oui.",
   "worker_model_run_script": "Script de lancement",
   "worker_model_status": "Statut",
   "worker_model_template": "Template",