DUE TO SPAM, SIGN-UP IS DISABLED. Goto Selfserve wiki signup and request an account.
What's this?
Details on the documentation needs for ACS 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 Apache CloudStack 4.1 QA Plan. The following table lists the new features and how they affect documentation. We are committed to provide documentation for features marked P1 and P2.
Update Docs for New Features
|
Feature |
Impact on the Documentation |
Engineering Contacts |
Links: Engineering Functional Spec + Doc Bug Number |
Hours |
Writer |
Status |
|---|---|---|---|---|---|---|---|
1 |
AWS-Style Regions |
|
Kishan Kavala |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/AWS-Style+Regions |
|
JT |
|
2 |
F5 & SRX inline mode |
|
Sheng |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Network+inline+mode+functional+spec |
|
Radhika |
done |
3 |
AutoScale |
|
Vijay |
Eng: CLOUDSTACK-637 |
|
Radhika |
done |
4 |
Advanced Search UI |
|
Brian |
Doc: CLOUDSTACK-827 |
|
|
Parent eng bug marked Reopened 2/27 |
5 |
S3-backed Secondary Storage |
|
John Burwell |
|
|
|
|
6 |
EC2 Query API support |
|
Likitha |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/EC2++-+Functional+Spec+for+Query+API+support |
|
Sebastien |
On Track |
7 |
API Request Throttling |
|
Min |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/API+Request+Throttling |
|
JT |
Ready to document |
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 |
On Track. |
10 |
OVS support in KVM |
|
Hugo |
|
Hugo |
Done |
|
11 |
Reset SSH Key to access VM (similar to reset password) |
|
Harikrishna Patnala |
|
JT |
done |
|
12 |
Security Groups Isolation in Advanced Zone |
|
Anthony |
|
JT |
done |
|
13 |
Site-to-Site VPN: Monitoring of VPN Tunnels |
|
Sheng |
https://issues.apache.org/jira/browse/CLOUDSTACK-703 |
|
Radhika |
done |
14 |
Persistent Networks without running a VM |
|
Likitha |
Doc: CLOUDSTACK-852 |
|
Radhika |
done |
15 |
Egress firewall rules for guest network |
|
Jaypal Reddy |
|
Radhika |
done |
|
16 |
Additional VMX Settings |
|
Vijay B |
Doc: CLOUDSTACK-811 |
|
Radhika |
done |
17 |
Resize volumes feature |
|
Marcus Sorensen |
Doc: CLOUDSTACK-887 |
|
Radhika |
tech review |
18 |
Add/remove network on VM |
|
Marcus Sorensen |
Doc: CLOUDSTACK-890 |
|
|
Parent eng bug still open 2/27 |
19 |
Limit API Queries (CLOUDSTACK-618) |
|
Min Chen |
? |
|
JT |
|
20 |
Improve API Performance / Add Search Capabilities |
|
Min Chen |
? |
|
JT |
|
21 |
Allow for same vlan on different physical nics |
|
Marcus |
https://issues.apache.org/jira/browse/CLOUDSTACK-686 (Kishan has done only schema changes) |
|
|
|
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 |
|
Rohit |
|
|
|
|
26 |
Update Developer Guide |
|
|
|
|
Radhika |
On Track |
27 |
Release Notes 4.1 |
|
|
|
|
jzb |
|
28 |
Update Installation Guides |
|
|
|
|
jzb |
|
Installation Guides: Update
Each new releases requires an update of the existing Installation Guide. A rewrite is required for "build from source" installation procedure.Looking for community contribution.
Hours: Up to 32 hours
Release Notes
Each new release requires an update of existing Release Notes. New features, Known issues, and Fixed issues sections require major rewrite.
Hours: Up to 32 hours including the review cycle.
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.
Hours: Up to 8 hours maximum if no rewrite is planned.
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.
Hours: Dedicating up to 60 hours for defect closure.This might vary based on the feature requirements.
Translation
Publican can output .po files which we can use to translate documentation into any desired language. DECISIONS REQUIRED:
- Which languages to translate?
- Use Transifex
- Use community volunteers? We already have one volunteer for Chinese translation.
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: Done
Resubmitted the patch https://reviews.apache.org/r/8636/
Allow for same vlan on different physical nics: sent for review
Overview
Content Tools