What's this?
Details on the documentation needs for Apache CloudStack 4.1.
Purpose
- Update documentation for new features.
- Update documentation for UI changes.
- Respond to change request and bug tickets.
Assumptions and Risks
The time available before the release is short. The list of features to be included in the release is in flux, making it difficult to plan which features to write about first.
Documentation Deliverables and Outlines
The Documentation plan is derived from the 4.1 Release Page and the Apache CloudStack 4.1 QA Plan. The following table lists the new features and how they affect documentation.
Update Docs for New Features
|
Feature |
Impact on the Documentation |
Engineering Contacts |
Links: Engineering Functional Spec + Doc Bug Number |
Writer |
Status |
|---|---|---|---|---|---|---|
1 |
AWS-Style Regions |
aws-ec2-introduction.xml: add paragraph that gives an overview of the feature. |
Kishan Kavala |
Doc: CLOUDSTACK-815 |
JT |
API is documentation in the Dev Guide (radhika) |
2 |
F5 & SRX inline mode |
|
Sheng |
Doc: CLOUDSTACK-800 |
Radhika |
done |
3 |
AutoScale |
|
Vijay |
Doc: CLOUDSTACK-813 |
Radhika |
done |
4 |
Advanced Search UI |
Not sure this really needs documentation. |
Brian |
Doc: CLOUDSTACK-827 |
|
Parent eng bug marked Reopened 2/27 |
5 |
S3-backed Secondary Storage |
|
John Burwell |
Doc: CLOUDSTACK-878 |
|
Parent eng bug Reopened 2/27 |
6 |
EC2 Query API support |
|
Likitha |
Doc: CLOUDSTACK-829 |
Sebastien |
On Track. (When was this status written? Need to check in w/Sebastien) Parent eng bug is still open 2/27 |
7 |
API Request Throttling |
|
Min |
Doc: CLOUDSTACK-866 |
JT |
Feature is ready to document. Not started. |
8 |
Enhanced baremetal servers support on Cisco UCS |
|
Frank zhang |
Doc: CLOUDSTACK-861 |
Radhika |
Parent eng bug marked In Progress 2/27 |
9 |
Events framework to publish/subscribe to CloudStack events |
|
Murali |
Doc: CLOUDSTACK-1270 |
Radhika |
Done. |
10 |
OVS support in KVM |
|
Hugo |
Doc: CLOUDSTACK-824 |
Hugo |
Done |
11 |
Reset SSH Key to access VM (similar to reset password) |
|
Harikrishna Patnala |
Doc: CLOUDSTACK-830 |
JT |
done. Worth double-checking that the doc is in 4.1, not just master. |
12 |
Security Groups Isolation in Advanced Zone |
|
Anthony |
Doc: CLOUDSTACK-805 |
JT |
done. *ALERT* It appears the feature code was reverted, but the docs were not. Need to check into this! |
13 |
Site-to-Site VPN: Monitoring of VPN Tunnels |
|
Sheng |
Doc: CLOUDSTACK-806 |
Radhika |
done. *ALERT* The parent eng bug has been moved to 4.2. Need to check whether the docs were reverted. (Radhika: The sub task monitoring vpn tunnel is part of 4.1. Confirmed)(JT: Thanks Radhika. Then this is really "Done.") |
14 |
Persistent Networks without running a VM |
|
Likitha |
Doc: CLOUDSTACK-852 |
Radhika |
done |
15 |
Egress firewall rules for guest network |
|
Jaypal Reddy |
Doc: CLOUDSTACK-1028 |
Radhika |
Done. |
16 |
Additional VMX Settings |
|
Vijay B |
Doc: CLOUDSTACK-811 |
Radhika |
done |
17 |
Resize volumes feature |
|
Marcus Sorensen |
Doc: CLOUDSTACK-887 |
Radhika |
done |
18 |
Add/remove network on VM |
|
Marcus Sorensen |
Doc: CLOUDSTACK-890 |
Radhika |
Done |
19 |
Limit API Queries |
|
Min Chen |
Doc: CLOUDSTACK-866 |
JT |
Parent eng bug marked Fixed in 4.1 2/27 |
20 |
Improve API Performance / Add Search Capabilities |
|
Min Chen |
Doc: CLOUDSTACK-865 |
JT |
Parent eng bug marked Fixed in 4.1. This is not listed in the 4.1 Features List-- why not? Docs not started. 2/27 |
21 |
Allow for same vlan on different physical nics |
|
Marcus |
Doc: CLOUDSTACK-1221 |
Radhika |
Done. Parent eng bug marked fixed for 4.1. (This is from the Improvements list on the 4.1 Release wiki page.) |
22 |
BigSwitch network plugin |
|
Kanzhe Jiang |
Doc: CLOUDSTACK-1442 |
JT |
Parent eng bug marked In Progress 2/27 |
23 |
ApiDiscoverService: Implement a plugin mechanism that exposes the list of APIs through a discovery service on the management server |
|
Rohit |
Doc: CLOUDSTACK-1441 |
|
Parent eng bug marked Fixed in 4.1 |
24 |
Implement L3 Router functionality in Nicira Nvp Plugin |
|
Hugo |
Doc: CLOUDSTACK-862 |
Hugo |
Parent eng bug marked Fixed in 4.1 |
25 |
Mash up marvin into an interactive auto-completing API shell for CloudStack (aka Cloudmonkey CLI) |
|
Rohit |
Doc: CLOUDSTACK-825 |
Sebastien |
Parent eng bug marked Fixed in 4.1. Doc bug still In Progress. There are some cloudmonkey docs in the wiki. 2/27 |
26 |
Baremetal kickstart |
|
Frank |
Doc: CLOUDSTACK-1478 |
JT |
Not started. (This is from the Improvements list on the 4.1 Release wiki page.) |
27 |
Nicira NVP/KVM |
Not sure whether this affects docs. |
Hugo |
Eng: CLOUDSTACK-727 |
|
?? (This is from the Improvements list on the 4.1 Release wiki page.) |
28 |
Netscaler plugin |
Not sure whether this is going in 4.1 |
Vijay V. |
Eng: CLOUDSTACK-716 |
|
?? (This is from the Improvements list on the 4.1 Release wiki page.) |
27 |
Update Developer Guide |
Add new/changed APIs to "What's New" lists |
|
|
Radhika |
On Track |
28 |
Release Notes 4.1 |
|
|
|
jzb |
|
29 |
Update Installation Guides |
|
|
|
jzb |
|
30 |
Documentation Bugs |
|
|
|
Need to fix, close, or bump. There are 54 open bugs as of 2/28. |
|
31 |
API changes for IPv6 Support |
|
|
|
Radhika |
|
Installation Guides: Update
Each new release requires an update of the existing Installation Guide. Looking for community contribution.
Release Notes
Each new release requires an update of existing Release Notes. New features, Known issues, and Fixed issues sections require major rewrite.
API Reference: Update
Each new release requires an update of the existing API Reference man pages. These are auto-generated and require only posting to the website.
Documentation Bugs
It is assumed that bugs will be filed against documentation and some will be prioritized for this release. Currently known doc bugs per release can be obtained by querying the bugbase. Triage of existing bugs is needed to determine which are required in this release. The goal is to address as many as possible of the bugs that reflect inaccuracies in the documentation. Enhancement requests can be targeted to a later release.
Translation
Publican can output .po files which we can use to translate documentation into any desired language.
We are using Transifex to obtain community contributed translations of the documentation. For more information, see http://www.slideshare.net/sebastiengoasguen/how-to-translate-apache-cloudstack-docs.
Additional Doc Activities
In addition to the deliverables noted,additional activities are required during this time frame.
- Community outreach activities: presentations at professional gatherings, presence on mailing lists and social media, organizing CloudStack meetups etc.
Timeline
Feb 4-11
Persistent Network
Status: Shared for review (Sailaja and Likitha)
Doc impact: Admin Guide, Developer Guide, and Release Notes
Feb 11-15
Persistent Network
Status: Patch submitted (Admin Guide, Dev Guide)
AWS-Style Regions
Status: Research state
Doc impact: Admin Guide, Developer Guide, and Release Notes
Event Notification Framework
Status: First draft of conceptual info ready
Developer Guide
Status: Patch is submitted ( initial set of API changes included)
Feb 18-22
Event Notification Framework: Tech review done. Incorporating comments. Awaiting info on configuration part.
CLOUDSTACK-1313: Patch submitted. Need to merge on Master and 4.0 (https://reviews.apache.org/r/9492/)
CLOUDSTACK-991: Patch merged (https://reviews.apache.org/r/9490/)
Resize Volume: Patch submitted. Ready to review (https://reviews.apache.org/r/9520/)
S2S VPN: Patch submitted. Need to merge (https://reviews.apache.org/r/9514/)
Feb 25 - March 1
Event Notification Framework: Merged.
Resubmitted the patch https://reviews.apache.org/r/8636/
Allow for same vlan on different physical nics: Swamy reviewed. Merged to master n 4.1
IP Reservation (4.2 feature): sent for tech review
March 4-8
IP Reservation (4.2 feature): Review comments incorporated (3/5)
Add/Remove Network on VM : https://reviews.apache.org/r/9726/
AWS Style Regions: Dev Guide has been updated
IPv6 API: First draft shared with QA for review
March 11-15
dvSwitch: Documented the UI specific tasks, overview
IPv6: Done review with QA. Addition points have been added.
March 18-21
IPv6: Send for second round of technical review
Fixed CLOUDSTACK-1409
Overview
Content Tools
Apps