Skip to content

Commit

Permalink
Update system roles documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
imobachgs committed Mar 9, 2017
1 parent 1536e5c commit a028e61
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions doc/control-file.md
Expand Up @@ -1303,6 +1303,12 @@ the installation workflow. Basically, adding proposal has two steps:
Is possible as replacing or removing a step of the installation
workflow.

#### Adding new system roles

Add-ons are allowed to define additional system roles. Those roles will be shown
at the bottom of the list of already existing roles. For the time being,
modifying or removing system roles is not possible.

### File layout

#### Add-on Product CD
Expand Down Expand Up @@ -1500,6 +1506,17 @@ section, which defines changes to the existing workflow and proposals.
<module>before_umount_2</module>
</before_umount>
</inst_finish>
<system_roles>
<insert_system_roles config:type="list">
<insert_system_roles>
<system_roles config:type="list">
<system_role>
<id>additional_role</id>
</system_role>
</system_roles>
</insert_system_roles>
</insert_system_roles>
</system_roles>
</update>
</productDefines>
```
Expand Down Expand Up @@ -1761,6 +1778,27 @@ modules specified in the add-on product control file.
</clone_modules>
```

### Adding a system role

This example shows how to add an additional `example_role`.

```xml
<system_roles>
<insert_system_roles config:type="list">
<insert_system_roles>
<system_roles config:type="list">
<system_role>
<id>example_role</id>
</system_role>
</system_roles>
</insert_system_roles>
</insert_system_roles>
</system_roles>
```

NOTE: do not forget to add labels and descriptions to the `texts` section. Check
*System Roles* section for more details.

### Example of OES 1.0

The network code is instructed to force a static IP address.
Expand Down

0 comments on commit a028e61

Please sign in to comment.