Bug #4887

Review TODOs in Documentation

Added by Tino Vázquez about 4 years ago. Updated about 3 years ago.

Status:NewStart date:10/31/2016
Priority:NormalDue date:
Assignee:Tino Vázquez% Done:

0%

Category:Documentation
Target version:Release 5.4.4
Resolution: Pull request:
Affected Versions:Development, OpenNebula 5.2

Description

/Users/tinova/dev/docs/build/html/_sources/advanced_components/ha/ftguide.txt:
10 =============
11
12: .. todo:: needs to be updated with new flags
13
14 When OpenNebula detects that a host is down, a hook can be triggered to deal with the situation. OpenNebula comes with a script out-of-the-box that can act as a hook to be triggered when a host enters the ERROR state. This can very useful to limit the downtime of a service due to a hardware failure, since it can redeploy the VMs on another host.

/Users/tinova/dev/docs/build/html/_sources/advanced_components/marketplace/marketapp.txt:
33
34
35: .. todo:: Sunstone
36
37 Show a MarketPlaceApp
..
93 Which demonstrates the capability of including a template into the appliance's data.
94
95: .. todo:: sunstone
96
97 Create a New MarketPlaceApp
..
136 ID: 40
137
138: .. todo:: sunstone
139
140 Exporting a MarketPlaceApp
...
153 ID: -1
154
155: .. todo:: Sunstone
156
157 .. _marketapp_download:

/Users/tinova/dev/docs/build/html/_sources/deployment/open_cloud_networking_setup/node.txt:
5 ====================
6
7: .. todo::
8
9 * Architect

/Users/tinova/dev/docs/build/html/_sources/deployment/sunstone_setup/cloud_auth.txt:
5 =============================
6
7: .. todo:: Mention oneflow
8
9 OpenNebula ships with two servers: :ref:`Sunstone <sunstone>` and :ref:`EC2 <ec2qcg>`. When a user interacts with one of them, the server authenticates the request and then forwards the requested operation to the OpenNebula daemon.

/Users/tinova/dev/docs/build/html/_sources/operation/references/overview.txt:
7 Every resource in OpenNebula has its own Template, a collection of attributes that modify its behavior and their relationship with other cloud components. This Chapter contains an exhaustive reference of the templates of various resources.
8
9: .. todo:: To discuss: do we need host template reference? datastore reference? public_cloud reference vcenter, ec2, azure?
10
11 How Should I Read This Chapter

/Users/tinova/dev/docs/build/html/_sources/operation/references/template.txt:
1008 ================================================================================
1009
1010: .. todo:: update with new types, and options
1011
1012 ``USER_INPUTS`` provides the template creator with the possibility to dynamically ask the user instantiating the template for dynamic values that must be defined.

/Users/tinova/dev/docs/build/html/_sources/operation/users_groups_management/manage_users.txt:
261 --------------------------------------------------------------------------------
262
263: .. todo:: This section uses oneuser token --create, which does not exist anymore
264
265 ``$HOME/.one/one_auth`` is just protected with the standard filesystem permissions. To improve the system security you can use authentication tokens. In this way there is no need to store plain passwords, OpenNebula can generate or use an authentication token with a given expiration time. By default, the tokens are also stored in ``$HOME/.one/one_auth``.

/Users/tinova/dev/docs/source/advanced_components/ha/ftguide.rst:
10 =============
11
12: .. todo:: needs to be updated with new flags
13
14 When OpenNebula detects that a host is down, a hook can be triggered to deal with the situation. OpenNebula comes with a script out-of-the-box that can act as a hook to be triggered when a host enters the ERROR state. This can very useful to limit the downtime of a service due to a hardware failure, since it can redeploy the VMs on another host.

/Users/tinova/dev/docs/source/advanced_components/marketplace/marketapp.rst:
33
34
35: .. todo:: Sunstone
36
37 Show a MarketPlaceApp
..
93 Which demonstrates the capability of including a template into the appliance's data.
94
95: .. todo:: sunstone
96
97 Create a New MarketPlaceApp
..
136 ID: 40
137
138: .. todo:: sunstone
139
140 Exporting a MarketPlaceApp
...
153 ID: -1
154
155: .. todo:: Sunstone
156
157 .. _marketapp_download:

/Users/tinova/dev/docs/source/deployment/open_cloud_networking_setup/node.rst:
5 ====================
6
7: .. todo::
8
9 * Architect

/Users/tinova/dev/docs/source/deployment/sunstone_setup/cloud_auth.rst:
5 =============================
6
7: .. todo:: Mention oneflow
8
9 OpenNebula ships with two servers: :ref:`Sunstone <sunstone>` and :ref:`EC2 <ec2qcg>`. When a user interacts with one of them, the server authenticates the request and then forwards the requested operation to the OpenNebula daemon.

/Users/tinova/dev/docs/source/operation/references/overview.rst:
7 Every resource in OpenNebula has its own Template, a collection of attributes that modify its behavior and their relationship with other cloud components. This Chapter contains an exhaustive reference of the templates of various resources.
8
9: .. todo:: To discuss: do we need host template reference? datastore reference? public_cloud reference vcenter, ec2, azure?
10
11 How Should I Read This Chapter

/Users/tinova/dev/docs/source/operation/references/template.rst:
1008 ================================================================================
1009
1010: .. todo:: update with new types, and options
1011
1012 ``USER_INPUTS`` provides the template creator with the possibility to dynamically ask the user instantiating the template for dynamic values that must be defined.

/Users/tinova/dev/docs/source/operation/users_groups_management/manage_users.rst:
261 --------------------------------------------------------------------------------
262
263: .. todo:: This section uses oneuser token --create, which does not exist anymore
264
265 ``$HOME/.one/one_auth`` is just protected with the standard filesystem permissions. To improve the system security you can use authentication tokens. In this way there is no need to store plain passwords, OpenNebula can generate or use an authentication token with a given expiration time. By default, the tokens are also stored in ``$HOME/.one/one_auth``.

History

#1 Updated by Ruben S. Montero over 3 years ago

  • Assignee set to Tino Vázquez

#2 Updated by Ruben S. Montero over 3 years ago

  • Target version changed from Release 5.4 to Release 5.4.1

#3 Updated by Ruben S. Montero over 3 years ago

  • Target version changed from Release 5.4.1 to Release 5.4.3

#4 Updated by OpenNebula Systems Support Team about 3 years ago

  • Target version changed from Release 5.4.3 to Release 5.4.4

Also available in: Atom PDF