erigones / esdc-docs Goto Github PK

Related to erigones/esdc-ce#98 erigones/esdc-ce#214

In Maintenance->Updating Danube Cloud section the values to -key and -cert parameters are files and should be passed with file:: prefix.

In the same section the order of updating must be properly defined in a sense that first the management server should be updated and then Compute nodes.

There is a need to document a vital es functionality - passing JSON and file data as a parameter. When the parameter value is prefixed with "json::", it's processed differently and not taken as a string (and therefore discarded as some fields expect json as a parameter). Analogically, file:: prefix is used, but not documented anywhere.

Should be places on the USB image into private/answers.json.

Example:

{
    "config_console": "vga",
    "skip_instructions": true,
    "simple_headers": true,
    "skip_final_confirm": true,
    "accept_eula": false,
    "datacenter_name": "XXX",
    "advanced_install": false,
    "add_nictags": false,
    "admin_ip": "XXX",
    "admin_netmask": "XXX",
    "admin_gateway": "XXX",
    "skip_ntp_check": false,
    "headnode_default_gateway": "XXX",
    "dns_resolver1": "<default>",
    "dns_resolver2": "<default>",
    "dns_domain": "<default>",
    "dns_search": "<default>",
    "ntp_host": "<default>",
    "hostname": "<default>",
    "root_password": "root",
    "admin_email": "[email protected]",
    "mgmt_admin_ip": "XXX",
    "esdc_install_password": "XXX",
    "disk_layout": "<default>",
    "install_to_hdd": false
}

• management of overlay rules on SmartOS - related to erigones/esdc-factory#85 and erigones/esdc-factory#91
• using overlays in Danube Cloud - related to erigones/esdc-ce#286

Or change names of permissions and distinguish between roles and permissions. Add some user stories.

Document /var/fw/{ipf,ipf6,ipnat}.conf

Recheck all qemu-img command examples in the user guide. Especially the conversion from a vmdk disk image.

Link to SmartOS documentation and document new options added by Erigones.

• esdc-git-update
• esdc-platform-upgrade

For a new person working on the project, it may be beneficial to have some short introduction and quickstart commands documented somewhere.

I started to notice a pattern in Danube Cloud GUI users behavior:

1. User doesn't understand something, so he opens docs.danubecloud.org
2. "Search docs" feature looks promising, so he copy paste or write down some keywords from the original screen.
3. User is dissapointed by the search results. While he is used to the common structure with headline and highlighted query found within a document fragment, he gets only topic headlines instead.
4. Afterwards he start to open found documents, full text searching the text occurrences with help of the browser, one by one.

It would be beneficial to improve the search result structure with the highlighting in the document fragment, adding the document hierarchical structure or visible url to the search result, etc.