Skip to content

Commit f70fc40

Browse files
davidjumaniyadvr
davidjumani
authored and
yadvr
committed
sections: add doc links (apache#435)
Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>
1 parent 92e0c5a commit f70fc40

23 files changed

Lines changed: 138 additions & 0 deletions

‎ui/src/config/section/account.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export default {
1919
name: 'account',
2020
title: 'label.accounts',
2121
icon: 'team',
22+
docHelp: 'adminguide/accounts.html',
2223
permission: ['listAccounts'],
2324
columns: ['name', 'state', 'rolename', 'roletype', 'domainpath'],
2425
details: ['name', 'id', 'rolename', 'roletype', 'domainpath', 'networkdomain', 'iptotal', 'vmtotal', 'volumetotal', 'receivedbytes', 'sentbytes', 'vmlimit', 'iplimit', 'volumelimit', 'snapshotlimit', 'templatelimit', 'vpclimit', 'cpulimit', 'memorylimit', 'networklimit', 'primarystoragelimit', 'secondarystoragelimit'],
@@ -59,6 +60,7 @@ export default {
5960
api: 'ldapCreateAccount',
6061
icon: 'user-add',
6162
label: 'label.add.ldap.account',
63+
docHelp: 'adminguide/accounts.html#using-an-ldap-server-for-user-authentication',
6264
listView: true,
6365
popup: true,
6466
show: (record, store) => {

‎ui/src/config/section/compute.js‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,15 @@ export default {
8787
api: 'deployVirtualMachine',
8888
icon: 'plus',
8989
label: 'label.vm.add',
90+
docHelp: 'adminguide/virtual_machines.html#creating-vms',
9091
listView: true,
9192
component: () => import('@/views/compute/DeployVM.vue')
9293
},
9394
{
9495
api: 'updateVirtualMachine',
9596
icon: 'edit',
9697
label: 'label.action.edit.instance',
98+
docHelp: 'adminguide/virtual_machines.html#changing-the-vm-name-os-or-group',
9799
dataView: true,
98100
args: ['name', 'displayname', 'ostypeid', 'isdynamicallyscalable', 'haenable', 'group'],
99101
show: (record) => { return ['Stopped'].includes(record.state) }
@@ -137,6 +139,7 @@ export default {
137139
icon: 'reload',
138140
label: 'label.action.reboot.instance',
139141
message: 'message.action.reboot.instance',
142+
docHelp: 'adminguide/virtual_machines.html#stopping-and-starting-vms',
140143
dataView: true,
141144
show: (record) => { return ['Running'].includes(record.state) },
142145
args: (record, store) => {
@@ -154,6 +157,7 @@ export default {
154157
icon: 'sync',
155158
label: 'label.reinstall.vm',
156159
message: 'message.reinstall.vm',
160+
docHelp: 'adminguide/virtual_machines.html#virtual-machine-snapshots',
157161
dataView: true,
158162
args: ['virtualmachineid', 'templateid'],
159163
show: (record) => { return ['Running', 'Stopped'].includes(record.state) },
@@ -167,6 +171,7 @@ export default {
167171
api: 'createVMSnapshot',
168172
icon: 'camera',
169173
label: 'label.action.vmsnapshot.create',
174+
docHelp: 'adminguide/virtual_machines.html#virtual-machine-snapshots',
170175
dataView: true,
171176
args: ['virtualmachineid', 'name', 'description', 'snapshotmemory', 'quiescevm'],
172177
show: (record) => {
@@ -184,6 +189,7 @@ export default {
184189
icon: 'folder-add',
185190
label: 'label.backup.offering.assign',
186191
message: 'label.backup.offering.assign',
192+
docHelp: 'adminguide/virtual_machines.html#backup-offerings',
187193
dataView: true,
188194
args: ['virtualmachineid', 'backupofferingid'],
189195
show: (record) => { return !record.backupofferingid },
@@ -197,6 +203,7 @@ export default {
197203
api: 'createBackup',
198204
icon: 'cloud-upload',
199205
label: 'label.create.backup',
206+
docHelp: 'adminguide/virtual_machines.html#creating-vm-backups',
200207
dataView: true,
201208
args: ['virtualmachineid'],
202209
show: (record) => { return record.backupofferingid },
@@ -210,6 +217,7 @@ export default {
210217
api: 'createBackupSchedule',
211218
icon: 'schedule',
212219
label: 'Configure Backup Schedule',
220+
docHelp: 'adminguide/virtual_machines.html#creating-vm-backups',
213221
dataView: true,
214222
popup: true,
215223
show: (record) => { return record.backupofferingid },
@@ -228,6 +236,7 @@ export default {
228236
icon: 'scissor',
229237
label: 'label.backup.offering.remove',
230238
message: 'label.backup.offering.remove',
239+
docHelp: 'adminguide/virtual_machines.html#restoring-vm-backups',
231240
dataView: true,
232241
args: ['virtualmachineid', 'forced'],
233242
show: (record) => { return record.backupofferingid },
@@ -241,6 +250,7 @@ export default {
241250
api: 'attachIso',
242251
icon: 'paper-clip',
243252
label: 'label.action.attach.iso',
253+
docHelp: 'adminguide/templates.html#attaching-an-iso-to-a-vm',
244254
dataView: true,
245255
args: ['id', 'virtualmachineid'],
246256
show: (record) => { return ['Running', 'Stopped'].includes(record.state) && !record.isoid },
@@ -272,6 +282,7 @@ export default {
272282
api: 'updateVMAffinityGroup',
273283
icon: 'swap',
274284
label: 'label.change.affinity',
285+
docHelp: 'adminguide/virtual_machines.html#change-affinity-group-for-an-existing-vm',
275286
dataView: true,
276287
args: ['affinitygroupids'],
277288
show: (record) => { return ['Stopped'].includes(record.state) }
@@ -281,6 +292,7 @@ export default {
281292
icon: 'arrows-alt',
282293
// label: label.change.service.offering
283294
label: 'Scale VM',
295+
docHelp: 'adminguide/virtual_machines.html#how-to-dynamically-scale-cpu-and-ram',
284296
dataView: true,
285297
args: ['serviceofferingid', 'details'],
286298
show: (record) => { return ['Running'].includes(record.state) && record.hypervisor !== 'KVM' && record.hypervisor !== 'LXC' }
@@ -289,6 +301,7 @@ export default {
289301
api: 'changeServiceForVirtualMachine',
290302
icon: 'sliders',
291303
label: 'label.change.service.offering',
304+
docHelp: 'adminguide/virtual_machines.html#changing-the-service-offering-for-a-vm',
292305
dataView: true,
293306
args: ['serviceofferingid'],
294307
show: (record) => { return ['Stopped'].includes(record.state) || (['Running'].includes(record.state) && record.hypervisor !== 'KVM' && record.hypervisor !== 'LXC') }
@@ -297,6 +310,7 @@ export default {
297310
api: 'migrateVirtualMachine',
298311
icon: 'drag',
299312
label: 'label.migrate.instance.to.host',
313+
docHelp: 'adminguide/virtual_machines.html#moving-vms-between-hosts-manual-live-migration',
300314
dataView: true,
301315
show: (record, store) => { return ['Running'].includes(record.state) && ['Admin'].includes(store.userInfo.roletype) },
302316
component: () => import('@/views/compute/MigrateWizard'),
@@ -313,6 +327,7 @@ export default {
313327
icon: 'drag',
314328
label: 'label.migrate.instance.to.ps',
315329
message: 'message.migrate.instance.to.ps',
330+
docHelp: 'adminguide/virtual_machines.html#moving-vms-between-hosts-manual-live-migration',
316331
dataView: true,
317332
show: (record, store) => { return ['Stopped'].includes(record.state) && ['Admin'].includes(store.userInfo.roletype) },
318333
args: ['storageid', 'virtualmachineid'],
@@ -340,6 +355,7 @@ export default {
340355
icon: 'lock',
341356
label: 'label.reset.ssh.key.pair',
342357
message: 'message.desc.reset.ssh.key.pair',
358+
docHelp: 'adminguide/virtual_machines.html#resetting-ssh-keys',
343359
dataView: true,
344360
args: ['keypair', 'account', 'domainid'],
345361
show: (record) => { return ['Running', 'Stopped'].includes(record.state) },
@@ -386,6 +402,7 @@ export default {
386402
icon: 'delete',
387403
label: 'label.action.expunge.instance',
388404
message: 'message.action.expunge.instance',
405+
docHelp: 'adminguide/virtual_machines.html#deleting-vms',
389406
dataView: true,
390407
show: (record, store) => { return ['Destroyed', 'Expunging'].includes(record.state) && store.features.allowuserexpungerecovervm }
391408
},
@@ -394,6 +411,7 @@ export default {
394411
icon: 'delete',
395412
label: 'label.action.destroy.instance',
396413
message: 'message.action.destroy.instance',
414+
docHelp: 'adminguide/virtual_machines.html#deleting-vms',
397415
args: ['expunge', 'volumeids'],
398416
mapping: {
399417
volumeids: {
@@ -411,6 +429,7 @@ export default {
411429
name: 'kubernetes',
412430
title: 'label.kubernetes',
413431
icon: kubernetes,
432+
docHelp: 'plugins/cloudstack-kubernetes-service.html',
414433
permission: ['listKubernetesClusters'],
415434
columns: ['name', 'state', 'size', 'cpunumber', 'memory', 'account', 'zonename'],
416435
details: ['name', 'description', 'zonename', 'kubernetesversionname', 'size', 'masternodes', 'cpunumber', 'memory', 'keypair', 'associatednetworkname', 'account', 'domain', 'zonename'],
@@ -423,6 +442,7 @@ export default {
423442
api: 'createKubernetesCluster',
424443
icon: 'plus',
425444
label: 'label.kubernetes.cluster.create',
445+
docHelp: 'plugins/cloudstack-kubernetes-service.html#creating-a-new-kubernetes-cluster',
426446
listView: true,
427447
popup: true,
428448
component: () => import('@/views/compute/CreateKubernetesCluster.vue')
@@ -431,20 +451,23 @@ export default {
431451
api: 'startKubernetesCluster',
432452
icon: 'caret-right',
433453
label: 'label.kubernetes.cluster.start',
454+
docHelp: 'plugins/cloudstack-kubernetes-service.html#starting-a-stopped-kubernetes-cluster',
434455
dataView: true,
435456
show: (record) => { return ['Stopped'].includes(record.state) }
436457
},
437458
{
438459
api: 'stopKubernetesCluster',
439460
icon: 'poweroff',
440461
label: 'label.kubernetes.cluster.stop',
462+
docHelp: 'plugins/cloudstack-kubernetes-service.html#stopping-kubernetes-cluster',
441463
dataView: true,
442464
show: (record) => { return !['Stopped'].includes(record.state) }
443465
},
444466
{
445467
api: 'scaleKubernetesCluster',
446468
icon: 'swap',
447469
label: 'label.kubernetes.cluster.scale',
470+
docHelp: 'plugins/cloudstack-kubernetes-service.html#scaling-kubernetes-cluster',
448471
dataView: true,
449472
show: (record) => { return ['Created', 'Running'].includes(record.state) },
450473
popup: true,
@@ -454,6 +477,7 @@ export default {
454477
api: 'upgradeKubernetesCluster',
455478
icon: 'plus-circle',
456479
label: 'label.kubernetes.cluster.upgrade',
480+
docHelp: 'plugins/cloudstack-kubernetes-service.html#upgrading-kubernetes-cluster',
457481
dataView: true,
458482
show: (record) => { return ['Created', 'Running'].includes(record.state) },
459483
popup: true,
@@ -463,6 +487,7 @@ export default {
463487
api: 'deleteKubernetesCluster',
464488
icon: 'delete',
465489
label: 'label.kubernetes.cluster.delete',
490+
docHelp: 'plugins/cloudstack-kubernetes-service.html#deleting-kubernetes-cluster',
466491
dataView: true,
467492
show: (record) => { return !['Destroyed', 'Destroying'].includes(record.state) }
468493
}
@@ -522,6 +547,7 @@ export default {
522547
api: 'createSSHKeyPair',
523548
icon: 'plus',
524549
label: 'label.create.ssh.key.pair',
550+
docHelp: 'adminguide/virtual_machines.html#creating-the-ssh-keypair',
525551
listView: true,
526552
popup: true,
527553
component: () => import('@/views/compute/CreateSSHKeyPair.vue')
@@ -564,6 +590,7 @@ export default {
564590
api: 'createAffinityGroup',
565591
icon: 'plus',
566592
label: 'label.add.affinity.group',
593+
docHelp: 'adminguide/virtual_machines.html#creating-a-new-affinity-group',
567594
listView: true,
568595
args: ['name', 'description', 'type'],
569596
mapping: {
@@ -576,6 +603,7 @@ export default {
576603
api: 'deleteAffinityGroup',
577604
icon: 'delete',
578605
label: 'label.delete.affinity.group',
606+
docHelp: 'adminguide/virtual_machines.html#delete-an-affinity-group',
579607
message: 'message.delete.affinity.group',
580608
dataView: true
581609
}

‎ui/src/config/section/domain.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export default {
1919
name: 'domain',
2020
title: 'label.domains',
2121
icon: 'block',
22+
docHelp: 'adminguide/accounts.html#domains',
2223
permission: ['listDomains', 'listDomainChildren'],
2324
resourceType: 'Domain',
2425
columns: ['name', 'state', 'path', 'parentdomainname', 'level'],
@@ -91,6 +92,7 @@ export default {
9192
api: 'linkDomainToLdap',
9293
icon: 'link',
9394
label: 'label.link.domain.to.ldap',
95+
docHelp: 'adminguide/accounts.html#using-an-ldap-server-for-user-authentication',
9496
listView: true,
9597
dataView: true,
9698
args: ['type', 'domainid', 'name', 'accounttype', 'admin'],

‎ui/src/config/section/event.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export default {
1919
name: 'event',
2020
title: 'label.events',
2121
icon: 'schedule',
22+
docHelp: 'adminguide/events.html',
2223
permission: ['listEvents'],
2324
columns: ['username', 'description', 'state', 'level', 'type', 'account', 'domain', 'created'],
2425
details: ['username', 'id', 'description', 'state', 'level', 'type', 'account', 'domain', 'created'],
@@ -33,6 +34,7 @@ export default {
3334
icon: 'book',
3435
label: 'label.archive.events',
3536
message: 'message.confirm.archive.selected.events',
37+
docHelp: 'adminguide/events.html#deleting-and-archiving-events-and-alerts',
3638
listView: false,
3739
dataView: true,
3840
args: ['ids'],
@@ -47,6 +49,7 @@ export default {
4749
icon: 'delete',
4850
label: 'label.delete.events',
4951
message: 'message.confirm.remove.selected.events',
52+
docHelp: 'adminguide/events.html#deleting-and-archiving-events-and-alerts',
5053
listView: false,
5154
dataView: true,
5255
args: ['ids'],

‎ui/src/config/section/image.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export default {
2121
name: 'image',
2222
title: 'label.images',
2323
icon: 'picture',
24+
docHelp: 'adminguide/templates.html',
2425
children: [
2526
{
2627
name: 'template',
@@ -52,6 +53,7 @@ export default {
5253
api: 'registerTemplate',
5354
icon: 'plus',
5455
label: 'label.action.register.template',
56+
docHelp: 'adminguide/templates.html#uploading-templates-from-a-remote-http-server',
5557
listView: true,
5658
popup: true,
5759
component: () => import('@/views/image/RegisterOrUploadTemplate.vue')
@@ -60,6 +62,7 @@ export default {
6062
api: 'registerTemplate',
6163
icon: 'cloud-upload',
6264
label: 'label.upload.template.from.local',
65+
docHelp: 'adminguide/templates.html#uploading-templates-and-isos-from-a-local-computer',
6366
listView: true,
6467
popup: true,
6568
component: () => import('@/views/image/RegisterOrUploadTemplate.vue')
@@ -76,6 +79,7 @@ export default {
7679
icon: 'cloud-download',
7780
label: 'label.action.download.template',
7881
message: 'message.action.download.template',
82+
docHelp: 'adminguide/templates.html#exporting-templates',
7983
dataView: true,
8084
show: (record) => { return record && record.isextractable },
8185
args: ['zoneid', 'mode'],
@@ -93,6 +97,7 @@ export default {
9397
api: 'updateTemplatePermissions',
9498
icon: 'reconciliation',
9599
label: 'label.action.share.template',
100+
docHelp: 'adminguide/templates.html#sharing-templates-with-other-accounts-projects',
96101
dataView: true,
97102
popup: true,
98103
show: (record, store) => { return (['Admin', 'DomainAdmin'].includes(store.userInfo.roletype) && (record.domainid === store.userInfo.domainid && record.account === store.userInfo.account) || record.templatetype !== 'BUILTIN') },
@@ -104,6 +109,7 @@ export default {
104109
name: 'iso',
105110
title: 'label.isos',
106111
icon: 'usb',
112+
docHelp: 'adminguide/templates.html#working-with-isos',
107113
permission: ['listIsos'],
108114
params: { isofilter: 'self', showunique: 'true' },
109115
resourceType: 'ISO',
@@ -127,6 +133,7 @@ export default {
127133
api: 'registerIso',
128134
icon: 'plus',
129135
label: 'label.action.register.iso',
136+
docHelp: 'adminguide/templates.html#id10',
130137
listView: true,
131138
popup: true,
132139
component: () => import('@/views/image/RegisterOrUploadIso.vue')
@@ -135,6 +142,7 @@ export default {
135142
api: 'registerIso',
136143
icon: 'cloud-upload',
137144
label: 'label.upload.iso.from.local',
145+
docHelp: 'adminguide/templates.html#id10',
138146
listView: true,
139147
popup: true,
140148
component: () => import('@/views/image/RegisterOrUploadIso.vue')
@@ -151,6 +159,7 @@ export default {
151159
icon: 'cloud-download',
152160
label: 'label.action.download.iso',
153161
message: 'message.action.download.iso',
162+
docHelp: 'adminguide/templates.html#exporting-templates',
154163
dataView: true,
155164
show: (record) => { return record && record.isextractable },
156165
args: ['zoneid', 'mode'],
@@ -168,6 +177,7 @@ export default {
168177
api: 'updateIsoPermissions',
169178
icon: 'reconciliation',
170179
label: 'label.action.edit.iso',
180+
docHelp: 'adminguide/templates.html#sharing-templates-with-other-accounts-projects',
171181
dataView: true,
172182
args: ['op', 'accounts', 'projectids'],
173183
popup: true,

‎ui/src/config/section/infra.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ export default {
5555
name: 'cpusocket',
5656
title: 'label.cpu.sockets',
5757
icon: 'inbox',
58+
docHelp: 'adminguide/management.html#reporting-cpu-sockets',
5859
permission: ['listHosts'],
5960
component: () => import('@/views/infra/CpuSockets.vue')
6061
},
@@ -69,6 +70,7 @@ export default {
6970
name: 'alert',
7071
title: 'label.alerts',
7172
icon: 'flag',
73+
docHelp: 'adminguide/management.html#administrator-alerts',
7274
permission: ['listAlerts'],
7375
columns: ['name', 'description', 'type', 'sent'],
7476
details: ['name', 'id', 'type', 'sent', 'description'],
@@ -78,6 +80,7 @@ export default {
7880
icon: 'book',
7981
label: 'label.archive.alerts',
8082
message: 'message.confirm.archive.selected.alerts',
83+
docHelp: 'adminguide/events.html#deleting-and-archiving-events-and-alerts',
8184
dataView: true,
8285
args: ['ids'],
8386
mapping: {
@@ -91,6 +94,7 @@ export default {
9194
icon: 'delete',
9295
label: 'label.delete.alerts',
9396
message: 'message.confirm.remove.selected.alerts',
97+
docHelp: 'adminguide/events.html#deleting-and-archiving-events-and-alerts',
9498
dataView: true,
9599
args: ['ids'],
96100
mapping: {

0 commit comments

Comments
 (0)