Skip to content

Commit

Permalink
[Help] Corrections for the in-app help.
Browse files Browse the repository at this point in the history
  • Loading branch information
Viktor Horvath committed Jan 14, 2015
1 parent 6b1a2e5 commit 02a0aa8
Show file tree
Hide file tree
Showing 39 changed files with 152 additions and 154 deletions.
12 changes: 6 additions & 6 deletions lib/cloud/Entity/Component/Physicalhoster0.pm
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ sub getManagerParamsDef {
pattern => '^\d*$',
is_mandatory => 1,
order => 1,
description => 'Required number of Core',
description => 'Required number of CPU cores',
},
ram => {
label => 'Required RAM amount',
type => 'integer',
unit => 'byte',
pattern => '^\d*$',
is_mandatory => 1,
description => 'Required RAM amount',
description => 'Required amount of RAM',
order => 2,
},
tags => {
Expand All @@ -133,17 +133,17 @@ sub getManagerParamsDef {
relation => 'multi',
is_mandatory => 0,
order => 3,
description => 'HCM offer tag system to filter resources. You can filter per datacenter'.
' or per users or per functionalities. Mandatorys tag are inclusive tags',
description => 'HCM offers a tag system to filter resources. You can filter per datacenter'.
' or per users or per functionalities. Mandatory tags are inclusive tags.',
},
no_tags => {
label => 'Forbidden Tags',
type => 'enum',
relation => 'multi',
is_mandatory => 0,
order => 4,
description => 'HCM offer tag system to filter resources. You can filter per datacenter '.
'or per users or per functionalities. Mandatorys tag are exclusive tags',
description => 'HCM offers a tag system to filter resources. You can filter per datacenter '.
'or per users or per functionalities. Forbidden tags are exclusive tags.',
},
};
}
Expand Down
8 changes: 4 additions & 4 deletions lib/cloud/Entity/Component/Virtualization.pm
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,30 @@ use constant ATTR_DEF => {
type => 'relation',
relation => 'single_multi',
is_editable => 1,
description => 'It is the vm images repositories',
description => 'Where VM images are stored',
},
hypervisors => {
label => 'Hypervisors',
type => 'relation',
relation => 'single_multi',
is_editable => 1,
description => 'It is the list of hypervisor in this virtualisation manager',
description => 'The list of hypervisors in this virtualisation manager',
},
overcommitment_cpu_factor => {
label => 'Overcommitment cpu factor',
type => 'integer',
pattern => '^\d*\.?\d+$',
is_mandatory => 0,
is_editable => 0,
description => 'Set a ratio for the CPU Overcommitment',
description => 'Set a ratio for CPU Overcommitment',
},
overcommitment_memory_factor => {
label => 'Overcommitment memory factor',
type => 'integer',
pattern => '^\d*\.?\d+$',
is_mandatory => 0,
is_editable => 0,
description => 'Set a ratio for the memory Overcommitment',
description => 'Set a ratio for Memory Overcommitment',
},
};

Expand Down
24 changes: 12 additions & 12 deletions lib/cloud/Entity/Host.pm
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ use constant ATTR_DEF => {
pattern => '^[0-9\.]*$',
is_mandatory => 0,
is_editable => 0,
description => 'It is the manager of this host (IaaS for a vm, BladeManager for a blade, ...)',
description => 'The manager of this host (IaaS for a VM, BladeManager for a blade, ...)',
},
hostmodel_id => {
label => 'Board model',
Expand All @@ -74,7 +74,7 @@ use constant ATTR_DEF => {
pattern => '^\d*$',
is_mandatory => 0,
is_editable => 1,
description => 'Some servers need specific Kernel, if it is your case, choose one',
description => 'Some servers need a specific kernel. If this is your case, choose one.',
},
host_serial_number => {
label => 'Serial number',
Expand All @@ -83,14 +83,14 @@ use constant ATTR_DEF => {
is_mandatory => 1,
is_editable => 1,
description => 'This is your UUID, it identifies your server.' .
' It could be your internal id, the vendor id, ...',
' It could be your internal ID, the vendor ID, ...',
},
host_desc => {
label => 'Description',
type => 'text',
pattern => '^.*$',
is_mandatory => 0,
description => 'Describe your host here. Where is it rack ? DC, room, chassis, ...',
description => 'Describe your host here. Where is its rack? DC, room, chassis, ...',
is_editable => 1,
},
active => {
Expand All @@ -102,7 +102,7 @@ use constant ATTR_DEF => {
},
host_ram => {
label => 'RAM capability',
description => 'Amount of Ram on the server',
description => 'Amount of RAM in the server',
type => 'integer',
unit => 'byte',
pattern => '^\d*$',
Expand All @@ -112,7 +112,7 @@ use constant ATTR_DEF => {
},
host_core => {
label => 'CPU capability',
description => 'number of Core in your server (CPU x Core x Hyperthreading)',
description => 'Total number of cores in your server (CPU x Core x Hyperthreading)',
type => 'integer',
unit => 'core(s)',
pattern => '^\d*$',
Expand Down Expand Up @@ -140,30 +140,30 @@ use constant ATTR_DEF => {
relation => 'single_multi',
is_mandatory => 0,
is_editable => 1,
description => 'add the different network interfaces of your server',
description => 'Add the different network interfaces of your server.',
},
harddisks => {
label => 'Hard disks',
type => 'relation',
relation => 'single_multi',
is_mandatory => 0,
is_editable => 1,
description => 'add the different hard disks of your server',
description => 'Add the different hard disks of your server.',
},
ipmi_credentials => {
label => 'IPMI',
type => 'relation',
relation => 'single_multi',
is_mandatory => 0,
is_editable => 1,
description => 'add your ipmi credentials, HCM will be able to start and stop your server',
description => 'Add your IPMI credentials, HCM will be able to start and stop your server.',
},
admin_ip => {
label => 'Administration ip',
label => 'Administration IP',
is_virtual => 1,
},
remote_session_url => {
label => 'Remote session url',
label => 'Remote session URL',
is_virtual => 1,
},
};
Expand All @@ -185,7 +185,7 @@ sub methods {
description => 'remove an interface from this host',
},
addIface => {
description => 'add one or more interface to this host',
description => 'add one or more interfaces to this host',
},
};
}
Expand Down
16 changes: 8 additions & 8 deletions lib/cloud/Entity/Iface.pm
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ use constant ATTR_DEF => {
pattern => '^.*$',
is_mandatory => 1,
is_editable => 1,
description => 'It is Iface name, it is the name of the interface in your linux system (eg. eth0)',
description => 'The name of the interface in your Linux system (eg. "eth0")',
},
iface_mac_addr => {
label => 'MAC address',
Expand All @@ -46,31 +46,31 @@ use constant ATTR_DEF => {
'[0-9a-fA-F]{2}:[0-9a-fA-F]{2}:[0-9a-fA-F]{2}$',
is_mandatory => 0,
is_editable => 1,
description => 'this is the mac adress of your network interface, it is really important for PXE'.
' iface (grub file will be generated with this identifier',
description => 'The MAC address of your network interface. It is essential for the PXE'.
' interface, as it will be included in GRUB and DHCP configurations',
},
iface_pxe => {
label => 'PXE enabled',
type => 'boolean',
pattern => '^[01]$',
is_mandatory => 1,
is_editable => 1,
description => 'Is this interface will be use to boot on pxe ?',
description => 'Will this interface be used to boot through PXE?',
},
host_id => {
type => 'relation',
relation => 'single',
pattern => '^\d+$',
is_mandatory => 1,
description => 'this is the host identifier of the server hosting this network interface',
description => 'The host identifier of the server with this network interface',
},
master => {
type => 'string',
pattern => '^.*$',
is_mandatory => 0,
is_editable => 1,
description => 'Master field allow to specify which iface is master for bonding configuration.'.
'It is also used for route',
description => 'You can specify which interface is the master in a bonding configuration.'.
' It is also used for routing.',
},
netconf_ifaces => {
label => 'Network configurations',
Expand All @@ -79,7 +79,7 @@ use constant ATTR_DEF => {
link_to => 'netconf',
is_mandatory => 0,
is_editable => 1,
description => 'Choose network topology plugged on this interface',
description => 'Choose the network topology plugged on this interface.',
}
};

Expand Down
8 changes: 4 additions & 4 deletions lib/cloud/Entity/Netconf.pm
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ use constant ATTR_DEF => {
is_mandatory => 1,
is_editable => 1,
description => 'Netconf Name. A netconf is the configuration of a network interface.'.
'It can be composed by vlans associated with ip pool',
' It can be composed by VLANs associated with an IP pool.',
},
netconf_vlans => {
label => 'VLANs',
Expand All @@ -41,7 +41,7 @@ use constant ATTR_DEF => {
link_to => 'vlan',
is_mandatory => 0,
is_editable => 1,
description => 'Vlans attached to the network interface',
description => 'VLANs attached to the network interface',
},
netconf_poolips => {
label => 'Pools IPs',
Expand All @@ -59,8 +59,8 @@ use constant ATTR_DEF => {
pattern => '^.*$',
is_mandatory => 0,
is_editable => 1,
description => 'It is the role assigned to the network interface (bridge for vm (vm),'.
' load balancing interface (public), private network (private)',
description => 'The role assigned to the network interface - bridge for VM (vm),'.
' load balancing interface (public), private network (private).',
},
};

Expand Down
4 changes: 2 additions & 2 deletions lib/cloud/Entity/NetconfRole.pm
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ use constant ATTR_DEF => {
pattern => '^.*$',
is_mandatory => 1,
is_editable => 1,
description => 'It is the role assigned to the network interface (bridge for vm (vm),'.
' load balancing interface (public), private network (private)',
description => 'The role assigned to the network interface - bridge for VM (vm),'.
' load balancing interface (public), private network (private).',
},
};

Expand Down
11 changes: 5 additions & 6 deletions lib/cloud/Entity/Network.pm
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ use constant ATTR_DEF => {
pattern => '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$',
is_mandatory => 1,
is_editable => 1,
description => 'It is the network address (eg. 10.0.0.0 or 172.23.32.128)',
description => 'The network address (e.g. 10.0.0.0 or 172.23.32.128)',
},
network_netmask => {
label => 'Netmask',
Expand All @@ -59,17 +59,16 @@ use constant ATTR_DEF => {
pattern => '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$',
is_mandatory => 1,
is_editable => 1,
description => 'Gateway is an optional parameter to specify '.
'what is the ip of the gateway on this network',
description => 'This optional parameter specifies the gateway IP on this network',
},
poolips => {
label => 'Pools Ip',
label => 'IP pools',
type => 'relation',
relation => 'single_multi',
is_mandatory => 0,
is_editable => 1,
description => 'It is the list of ip pools available on this network.'.
'This pools will be used by HCM to assigned ip adress to service instances',
description => 'The list of IP pools available on this network.'.
'These pools will be used by HCM to assign IP addresses to service instances.',
},
};

Expand Down
8 changes: 4 additions & 4 deletions lib/cloud/Entity/Poolip.pm
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,21 @@ use constant ATTR_DEF => {
pattern => '.*',
is_mandatory => 1,
is_editable => 1,
description => 'This is the name of the ip pool'
description => 'Here you can give a name to this IP pool.'
},
poolip_first_addr => {
label => 'First Address',
pattern => '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$',
is_mandatory => 1,
is_editable => 1,
description => 'This is the first available ip that could be attached to vm',
description => 'The first available IP that could be attached to a VM',
},
poolip_size => {
label => 'Size',
pattern => '[0-9]{1,2}',
is_mandatory => 1,
is_editable => 1,
description => 'This is the number of available ip in the ip pool',
description => 'The number of available IPs in the pool',
},
network_id => {
label => 'Network',
Expand All @@ -66,7 +66,7 @@ use constant ATTR_DEF => {
pattern => '^\d*$',
is_mandatory => 1,
is_editable => 1,
description => 'This is the physical network hosting this ip pool'
description => 'The physical network hosting this IP pool'
},
};

Expand Down
4 changes: 2 additions & 2 deletions lib/cloud/Entity/Repository.pm
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ use constant ATTR_DEF => {
pattern => '^.*$',
is_mandatory => 1,
is_editable => 1,
description => 'It is the name of the vm image repository',
description => 'The name of the VM image repository or VM images',
},
container_access_id => {
label => 'Container access',
type => 'relation',
relation => 'single',
is_mandatory => 1,
is_editable => 1,
description => 'It is the export used for the vm image repository',
description => 'The export used for the VM image repository',
},
};

Expand Down
6 changes: 3 additions & 3 deletions lib/cloud/Entity/Vlan.pm
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ use constant ATTR_DEF => {
is_mandatory => 1,
is_extended => 0,
is_editable => 1,
description => 'It is the name of the vlan (use to find the vlan in the topology building)'.
' (eg admin, sdn, public, ...)',
description => 'You can give a name to this VLAN (used to find the VLAN in the topology, '.
'e.g. admin, sdn, public, ...)',
},
vlan_number => {
label => 'Number',
pattern => '^\d*$',
is_mandatory => 1,
is_extended => 0,
is_editable => 1,
description => 'It is the Vlan id',
description => 'The VLAN ID',
},
};

Expand Down
Loading

0 comments on commit 02a0aa8

Please sign in to comment.