Skip to content

Commit 87c37fc

Browse files
authored
M #-: Fix paths of FireEdge views (#61)
Sync to last PR on old docs site OpenNebula/docs#3265 --------- Signed-off-by: Pedro Ielpi <pielpi@opennebula.io>
1 parent 3dd6498 commit 87c37fc

6 files changed

Lines changed: 23 additions & 23 deletions

File tree

content/product/cloud_system_administration/multitenancy/fireedge_sunstone_views.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Using the OpenNebula FireEdge Sunstone Views you will be able to provide a simpl
1919
- [Group Admin View]({{% relref "#fireedge-groupadmin-view" %}}).
2020
- [Cloud View]({{% relref "#fireedge-cloud-view" %}}).
2121

22-
Each of these views is defined on a folder in `/etc/one/fireedge/sunstone` that contains many yaml as tabs are enabled in this view. On this path, there is also a file `/etc/one/fireedge/sunstone/sunstone-views.yaml` where is defined the default configuration (see [Defining a New OpenNebula Sunstone View or Customizing an Existing one]({{% relref "#fireedge-sunstone-views-define-new" %}}) to more information about configure or create a view).
22+
Each of these views is defined on a folder in `/etc/one/fireedge/sunstone/views` that contains as many yaml files as tabs are enabled in this view. On this path, there is also a file `/etc/one/fireedge/sunstone/views/sunstone-views.yaml` where is defined the default configuration (see [Defining a New OpenNebula Sunstone View or Customizing an Existing one]({{% relref "#fireedge-sunstone-views-define-new" %}}) to more information about configure or create a view).
2323

2424
<a id="fireedge-suns-views-default-views"></a>
2525

@@ -29,31 +29,31 @@ Each of these views is defined on a folder in `/etc/one/fireedge/sunstone` that
2929

3030
### Admin View
3131

32-
This view provides full control of the cloud. Details can be configured in the `/etc/one/fireedge/sunstone/admin/*.yaml` files.
32+
This view provides full control of the cloud. Details can be configured in the `/etc/one/fireedge/sunstone/views/admin/*.yaml` files.
3333

3434
![fireedge_sunstone_admin_dashboard](/images/fireedge_sunstone_admin_view.png)
3535

3636
<a id="fireedge-user-view"></a>
3737

3838
### User View
3939

40-
Based on the Admin View; it is an advanced user view. It is intended for users that need access to more actions than the limited set available in the cloud view. Users will not be able to manage nor retrieve the hosts and clusters of the cloud. They will be able to see Datastores and Virtual Networks in order to use them when creating a new Image or Virtual Machine, but they will not be able to create new ones. Details can be configured in the `/etc/one/fireedge/sunstone/user/*.yaml` file.
40+
Based on the Admin View; it is an advanced user view. It is intended for users that need access to more actions than the limited set available in the cloud view. Users will not be able to manage nor retrieve the hosts and clusters of the cloud. They will be able to see Datastores and Virtual Networks in order to use them when creating a new Image or Virtual Machine, but they will not be able to create new ones. Details can be configured in the `/etc/one/fireedge/sunstone/views/user/*.yaml` file.
4141

4242
![fireedge_sunstone_view_dashboard](/images/fireedge_sunstone_user_view.png)
4343

4444
<a id="fireedge-groupadmin-view"></a>
4545

4646
### Group Admin View
4747

48-
Based on Users View; this view has the same tabs as the User View plus the Groups and Users tabs to manage the group and the users of the groups that this user is administrator. Details can be configured in the `/etc/one/fireedge/sunstone/groupadmin/*.yaml` files.
48+
Based on Users View; this view has the same tabs as the User View plus the Groups and Users tabs to manage the group and the users of the groups that this user is administrator. Details can be configured in the `/etc/one/fireedge/sunstone/views/groupadmin/*.yaml` files.
4949

5050
![fireedge_sunstone_groupadmin_dashboard](/images/fireedge_sunstone_groupadmin_view.png)
5151

5252
<a id="fireedge-cloud-view"></a>
5353

5454
### Cloud View
5555

56-
This is a simplified view, mainly intended for end-users that just require a portal where they can provision new virtual machines easily from pre-defined Templates. For more information about this view, please check the `/etc/one/fireedge/sunstone/cloud/*.yaml` files.
56+
This is a simplified view, mainly intended for end-users that just require a portal where they can provision new virtual machines easily from pre-defined Templates. For more information about this view, please check the `/etc/one/fireedge/sunstone/views/cloud/*.yaml` files.
5757

5858
![fireedge_sunstone_cloud_dashboard](/images/fireedge_sunstone_cloud_view.png)
5959

@@ -73,7 +73,7 @@ FireEdge Sunstone users can change their current view from the top-right drop-do
7373

7474
![fireedge_sunstone_views_change](/images/fireedge_sunstone_views_change.png)
7575

76-
These options are saved in the group template, as well as other hidden settings. If not defined, defaults views from `/etc/one/fireedge/sunstone/sunstone-views.yaml` are taken.
76+
These options are saved in the group template, as well as other hidden settings. If not defined, defaults views from `/etc/one/fireedge/sunstone/views/sunstone-views.yaml` are taken.
7777

7878
<a id="fireedge-sunstone-views-define-new"></a>
7979

@@ -128,10 +128,10 @@ The file `sunstone-views.yaml` configures:
128128
129129
## Defining a New OpenNebula Sunstone View or Customizing an Existing one
130130
131-
View definitions are placed in the `/etc/one/fireedge/sunstone` directory. Each view is defined by a folder which contains one yaml file for each tab that will be in the view. The structure of this folder will be as follows:
131+
View definitions are placed in the `/etc/one/fireedge/sunstone/views` directory. Each view is defined by a folder which contains one yaml file for each tab that will be in the view. The structure of this folder will be as follows:
132132

133133
```default
134-
/etc/one/fireedge/sunstone
134+
/etc/one/fireedge/sunstone/views
135135
|-- admin/
136136
| |-- acl-tab.yaml <--- Enable ACL tab and define its actions
137137
| |-- backupjobs-tab.yaml <--- Enable Backup jobs tab and define its actions
@@ -312,7 +312,7 @@ dialogs:
312312
313313
To create a new view:
314314
315-
> 1. Create a folder with the name of the view in `/etc/one/fireedge/sunstone`.
315+
> 1. Create a folder with the name of the view in `/etc/one/fireedge/sunstone/views`.
316316
> 2. Add the yaml files for each tab that the view will show.
317317
> 3. Configure `sunstone-views.yaml` if needed.
318318
> 4. Update or create a group to use the new view.

content/product/control_plane_configuration/graphical_user_interface/fireedge_sunstone.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,38 +129,38 @@ Each view is in an individual directory, `admin`, `user`, `groupadmin` and `clou
129129

130130
### Admin View
131131

132-
This view provides complete control of the Virtual Machines, Templates, and Marketplace apps. Details can be configured in the `/etc/one/fireedge/sunstone/admin/` directory.
132+
This view provides complete control of the Virtual Machines, Templates, and Marketplace apps. Details can be configured in the `/etc/one/fireedge/sunstone/views/admin/` directory.
133133

134134
![fireedge_sunstone_admin_view](/images/fireedge_sunstone_admin_view.png)
135135

136136
<a id="fireedge-sunstone-user-view"></a>
137137

138138
### User View
139139

140-
Based on the Admin View. It is an advanced user view intended for users with fewer privileges than an admin user, allowing them to manage Virtual Machines and Templates. Users will not be able to manage or retrieve the hosts and clusters of the cloud. Details can be configured in the `/etc/one/fireedge/sunstone/user/` directory.
140+
Based on the Admin View. It is an advanced user view intended for users with fewer privileges than an admin user, allowing them to manage Virtual Machines and Templates. Users will not be able to manage or retrieve the hosts and clusters of the cloud. Details can be configured in the `/etc/one/fireedge/sunstone/views/user/` directory.
141141

142142
![fireedge_sunstone_user_view](/images/fireedge_sunstone_user_view.png)
143143

144144
<a id="fireedge-sunstone-groupadmin-view"></a>
145145

146146
### Groupadmin View
147147

148-
This view it’s like a limited version of the cloud administrator view to be used by the administrators of a group. Details can be configured in the `/etc/one/fireedge/sunstone/groupadmin/` directory. More details on [Group admin view]({{% relref "groupadmin_view#group-admin-view" %}})
148+
This view it like a limited version of the cloud administrator view to be used by the administrators of a group. Details can be configured in the `/etc/one/fireedge/sunstone/views/groupadmin/` directory. More details on [Group admin view]({{% relref "groupadmin_view#group-admin-view" %}})
149149

150150
<a id="fireedge-sunstone-cloud-view"></a>
151151

152152
### Cloud View
153153

154-
This is a simplified view intended for cloud consumers that just require a portal where they can provision new VMs easily. Details can be configured in the `/etc/one/fireedge/sunstone/cloud/` directory. More details on [Cloud view]({{% relref "cloud_view#cloud-view" %}})
154+
This is a simplified view intended for cloud consumers that just require a portal where they can provision new VMs easily. Details can be configured in the `/etc/one/fireedge/sunstone/views/cloud/` directory. More details on [Cloud view]({{% relref "cloud_view#cloud-view" %}})
155155

156156
<a id="fireedge-sunstone-new-view"></a>
157157

158158
### Defining a New View
159159

160-
The views definitions are placed in the `/etc/one/fireedge/sunstone/` directory. Each view is defined by a folder (named as the view) with the needed configuration files inside.
160+
The views definitions are placed in the `/etc/one/fireedge/sunstone/views` directory. Each view is defined by a folder (named as the view) with the needed configuration files inside.
161161

162162
```default
163-
/etc/one/fireedge/sunstone/
163+
/etc/one/fireedge/sunstone/views
164164
...
165165
|-- admin/
166166
| |-- backup-tab.yaml <--- the Backup tab configuration file
@@ -187,7 +187,7 @@ The views definitions are placed in the `/etc/one/fireedge/sunstone/` directory.
187187
...
188188
```
189189

190-
The easiest way to create a custom view is to copy the `admin` or `user` folder and modify its content as needed. After that, add the new view into `/etc/one/fireedge/sunstone/sunstone-views.yaml`.
190+
The easiest way to create a custom view is to copy the `admin` or `user` folder and modify its content as needed. After that, add the new view into `/etc/one/fireedge/sunstone/views/sunstone-views.yaml`.
191191

192192
### View Customization
193193

content/product/operation_references/opennebula_services_configuration/fireedge.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ In HA environments, `fireedge_key` needs to be copied from the first leader to t
104104

105105
You can add your logo to the login, main, favicon and loading screens by updating the `logo:` attribute as follows:
106106

107-
- The logo configuration is done in the `/etc/one/fireedge/sunstone/sunstone-views.yaml` file.
107+
- The logo configuration is done in the `/etc/one/fireedge/sunstone/views/sunstone-views.yaml` file.
108108
- The logo of the main UI screen is defined for each view.
109109

110110
The logo image must be copied to `/usr/lib/one/fireedge/dist/client/assets/images/logos`.
111111

112112
The following example shows how you can change the logo to a generic linux one (included by default in all FireEdge installations):
113113

114114
```yaml
115-
# /etc/one/fireedge/sunstone/sunstone-views.yaml
115+
# /etc/one/fireedge/sunstone/views/sunstone-views.yaml
116116
---
117117
logo: linux.png
118118

content/software/installation_process/build_from_source_code/sunstone_dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ Now let's create a new module called `CustomContainers`, based off the original
462462
We will do this for the oneadmin user only
463463
464464
```default
465-
cp /etc/one/fireedge/sunstone/admin/user-tab.yaml /etc/one/fireedge/sunstone/admin/usersgroups-tab.yaml
465+
cp /etc/one/fireedge/sunstone/views/admin/user-tab.yaml /etc/one/fireedge/sunstone/views/admin/usersgroups-tab.yaml
466466
```
467467
468468
And then we update the resource name inside the new `usersandgroups-tab.yaml` view file to match the path of our component

content/software/upgrade_process/configuration_management_ee/appendix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ managed by the `onecfg` tool:
4040
| `/etc/one/fireedge/provision/provision-server.conf` | YAML |
4141
| `/etc/one/fireedge/sunstone/*/*.yaml` | YAML |
4242
| `/etc/one/fireedge/sunstone/sunstone-server.conf` | YAML |
43-
| `/etc/one/fireedge/sunstone/sunstone-views.yaml` | YAML |
43+
| `/etc/one/fireedge/sunstone/views/sunstone-views.yaml` | YAML |
4444
| `/etc/one/guacd` | Shell |
4545
| `/etc/one/monitord.conf` | oned.conf-like |
4646
| `/etc/one/oned.conf` | oned.conf-like |

content/software/upgrade_process/configuration_management_ee/conflicts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ Example of multiple patch modes for multiple files:
8686
--patch-modes skip,replace:/etc/one/oned.conf:5.10.0 \
8787
--patch-modes force:/etc/one/fireedge/sunstone-views.yaml:5.6.0 \
8888
--patch-modes replace:/etc/one/fireedge-server.conf \
89-
--patch-modes skip:/etc/one/fireedge/sunstone/admin/acl-tab.yaml:5.4.1 \
90-
--patch-modes skip:/etc/one/fireedge/sunstone/admin/vm-tab.yaml:5.4.2 \
91-
--patch-modes skip:/etc/one/fireedge/sunstone/admin/vm-template-tab.yaml
89+
--patch-modes skip:/etc/one/fireedge/sunstone/views/admin/acl-tab.yaml:5.4.1 \
90+
--patch-modes skip:/etc/one/fireedge/sunstone/views/admin/vm-tab.yaml:5.4.2 \
91+
--patch-modes skip:/etc/one/fireedge/sunstone/views/admin/vm-template-tab.yaml
9292
```
9393

9494
## Restore from Backup

0 commit comments

Comments
 (0)