openstack-origin config setting documentation is stale and incomplete
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Nova Compute Charm |
Fix Released
|
Medium
|
Unassigned | ||
nova-compute (Juju Charms Collection) |
Invalid
|
Medium
|
Unassigned |
Bug Description
the doc string in config.yaml for this charm only covers Precise and Trusty, and doesn't mention openstack liberty.
Ideally the docs would be up to date with what the charm currently supports, and would also mention what versions of openstack are supported with non-LTS releases. I looked at the code, and it looks like the LTS releases support many openstack versions , while the non-LTS releases only support a single openstack release, the one that was concurrently released. The docs should mention that.
I think probably a good solution here is to have config.yaml just point to a URL, maybe on the wiki where you post the release notes, and have a full and current matrix of supported versions at that URL.
This affects most of the openstack charms.
Changed in nova-compute (Juju Charms Collection): | |
status: | New → Confirmed |
importance: | Undecided → Medium |
tags: | added: openstack |
Changed in nova-compute (Juju Charms Collection): | |
status: | Confirmed → Triaged |
Changed in charm-nova-compute: | |
importance: | Undecided → Medium |
status: | New → Triaged |
Changed in nova-compute (Juju Charms Collection): | |
status: | Triaged → Invalid |
Changed in charm-nova-compute: | |
status: | Fix Committed → Fix Released |
+1 to making this more clear. Currently, there is a certain amount of research and assumption placed on the user to determine:
"What versions of Ubuntu + OpenStack can I deploy with this charm?"
I'd suggest that:
(a) Each of the OpenStack Charms ReleaseNotes wiki pages should be issued containing the then-current list of deployable combinations (and which are LTS, which are iterim/dev/test).
and
(b) Each of the OpenStack Charms READMEs should point to that ReleaseNotes wiki URL, in addition to these: /wiki.ubuntu. com/ServerTeam/ OpenStackCharms /wiki.ubuntu. com/ServerTeam/ CloudArchive www.ubuntu. com/info/ release- end-of- life
https:/
https:/
http://
...
Recent ReleaseNote examples: /wiki.ubuntu. com/ServerTeam/ OpenStackCharms /ReleaseNotes15 10 /wiki.ubuntu. com/ServerTeam/ OpenStackCharms /ReleaseNotes15 04 /wiki.ubuntu. com/ServerTeam/ OpenStackCharms /ReleaseNotes15 01
https:/
https:/
https:/