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.
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 |
Engineering Contacts |
Engineering Functional Spec |
Writer |
Status |
|
|---|---|---|---|---|---|---|
1 |
AWS-Style Regions |
Kishan Kavala |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/AWS-Style+Regions |
JT |
|
|
2 |
AWS-style Health Checks |
Rajesh Battala |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Load+Balancer+Health+checks |
JT |
|
|
3 |
Netscaler LB on Shared VLANs |
Rajesh Battala |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/LB+on+Shared+VLANs |
Radhika |
|
|
4 |
F5 & SRX inline mode |
Sheng |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Network+inline+mode+functional+spec |
Radhika |
On Track |
|
5 |
Optional Public IP assignment for EIP with Basic Zone |
Murali |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network |
Radhika |
|
|
6 |
AutoScale |
Vijay |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Autoscaling |
Radhika |
On Track |
|
7 |
Advanced Search UI |
Brian |
|
|
|
|
8 |
L4-L7 network services in shared network |
Murali |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network |
Radhika |
On Track |
|
9 |
S3-backed Secondary Storage |
John Burwell |
|
|
||
10 |
User provided hostname to be specified in vCenter |
Vijay B |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Allow+user+provided+hostname%2C+internal+VM+name+on+hypervisor+for+guest+VMs |
Radhika |
On Track |
|
11 |
EC2 Query API support |
Likitha |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/EC2++-+Functional+Spec+for+Query+API+support |
JT/ |
On Track |
|
12 |
API Request Throttling |
Min |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/API+Request+Throttling |
|
|
|
13 |
Storage subsystem 2.0 |
Edison |
https://issues.apache.org/jira/browse/CLOUDSTACK-629 |
|
|
|
14 |
High Availability: EIP enhancements |
Murali |
https://issues.apache.org/jira/browse/CLOUDSTACK-652https://issues.apache.org/jira/browse/CLOUDSTACK-652 |
Radhika |
|
|
16 |
VM's base image update facility (includes Reset a VM on reboot) |
Harikrishna Patnala |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility |
|
|
|
17 |
Enhanced baremetal servers support on Cisco UCS |
Frank zhang |
https://issues.apache.org/jira/browse/CLOUDSTACK-723 |
Radhika |
|
|
18 |
Events framework to publish/subscribe to CloudStack events |
Murali |
|
|
||
19 |
New Image based provisioning method for Baremetal |
Frank zhang |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Baremetal |
|
|
|
20 |
OVS support in KVM |
Hugo |
Hugo |
|
||
21 |
XenServer updates notifications |
Sanjay T |
JT |
|
||
22 |
Reset SSH Key to access VM (similar to reset password) |
Harikrishna Patnala |
JT |
On Track |
||
23 |
nTier Apps 2.0 Requirements |
Sheng + Kishan Kavala |
https://issues.apache.org/jira/browse/CLOUDSTACK-621 |
Radhika |
|
|
24 |
Support non-contiguous VLAN ranges |
Bharat |
Radhika |
|
||
25 |
Security Groups Isolation in Advanced Zone |
Anthony |
JT |
On Track |
||
26 |
Site-to-Site VPN: Monitoring of VPN Tunnels |
Sheng |
https://issues.apache.org/jira/browse/CLOUDSTACK-703 |
Radhika |
|
|
27 |
Dedicated Resources: |
Deepti |
|
|
||
28 |
Persistent Networks without running a VM |
Likitha |
Radhika |
Under Review |
||
29 |
Dedicated Resources - Public IP Addresses and VLANs per Tenant |
Likitha |
|
|
||
30 |
Dedicated Resources:Limit Resources to domain/accounts |
Sanjay Tripathi |
|
|
||
31 |
Egress firewall rules for guest network |
Jaypal Reddy |
Radhika |
On Track |
||
32 |
Specify egress rules on Physical device |
Jaypal Reddy |
Radhika |
|
||
33 |
Health monitoring for load balanced instances |
Rajesh |
|
|
||
34 |
3rd Party Plugin |
Sonny |
-https://issues.apache.org/jira/browse/CLOUDSTACK-625- |
|
|
|
35 |
IPv6 Support |
Sheng |
? |
Radhika |
|
|
36 |
Storage XenMotion/Migration |
Devdeep |
https://issues.apache.org/jira/browse/CLOUDSTACK-659 |
|
|
|
37 |
VMWare Enhancements: Support for DRS, VM HA |
Sateesh |
? |
|
|
|
38 |
VMware vNetwork Distributed Virtual Switch support in CloudStack |
Sateesh |
https://issues.apache.org/jira/browse/CLOUDSTACK-657 |
Radhika |
|
|
39 |
Additional VMX Settings |
Vijay B |
Radhika |
On Track |
||
40 |
Resize volumes feature |
Marcus Sorensen |
https://issues.apache.org/jira/browse/CLOUDSTACK-644 |
JT |
|
|
41 |
Add/remove network on VM |
Marcus Sorensen |
|
|
||
42 |
ELB: auto-scale request handling capacity by provisioning LB appliances |
Murali Reddy |
|
|
||
43 |
Framework for CloudStack to orchestrate virtual network appliances to provide network services |
Murali Reddy |
|
|
||
44 |
Support VM Snapshot |
Mice Xia |
|
|
||
45 |
Persistent Network Identity |
Hari P |
JT |
|
||
46 |
Multiple IP Address per NIC |
Jaypal |
https://issues.apache.org/jira/browse/CLOUDSTACK-24 |
Radhika |
|
|
47 |
CPU/Memory OverCommit |
Bharat (XS) |
JT |
|
||
48 |
Monitoring |
Anshul |
https://issues.apache.org/jira/browse/CLOUDSTACK-680 |
JT |
|
|
49 |
syslog enhancements |
Anshul |
|
|
||
50 |
Limit API Queries (CLOUDSTACK-618) |
Min Chen |
? |
JT |
|
|
51 |
Improve API Performance / Add Search Capabilities |
Min Chen |
? |
JT |
|
|
52 |
Object Store-Integration with CS as secondary Storage |
Nitin |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/S3-based+secondary+Storage |
Radhika |
|
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="51e3d078-86f3-405a-94ea-6e175a8cfe33"><ac:plain-text-body><![CDATA[ |
53 |
Zone-wide (primary) Block Storage |
Edison |
[https://issues.apache.org/jira/browse/CLOUDSTACK-724 |
JT |
|
52 |
Raise cluster size limit to 16 |
Koushik |
JT |
|
||
53 |
Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs) |
Nitin Mehta |
https://issues.apache.org/jira/browse/CLOUDSTACK-658 |
JT |
|
|
54 |
Allow for same vlan on different physical nics |
Kishan Kavala |
JT |
|
||
55 |
Multiple IP Ranges |
Bharat |
|
|
||
56 |
Integrate Cisco VSG in CloudStack |
Koushik Das |
|
|
||
57 |
Integrate Cisco ASA 1000v into CloudStack |
Koushik Das |
|
|
||
58 |
Zone-wide primary storage target |
Anthony |
JT |
|
||
59 |
IP Address reservation within a network |
Saksham |
Radhika |
|
||
60 |
Volume snapshot enhancements for VMware + Better VM Sync |
Kelven Yang |
-https://cwiki.apache.org/confluence/display/CLOUDSTACK/VMWare+Enhancements+-+Support+for+DRS+and+VM+HA- |
JT |
|
|
61 |
Configurable setting to use linked clones or not on VMware |
Vijay B |
-https://issues.apache.org/jira/browse/CLOUDSTACK-670- |
JT |
|
|
62 |
BigSwitch network plugin |
Kanzhe Jiang |
JT |
|
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fd54650f-2fc9-4d40-9bd8-f3c0dacb2e49"><ac:plain-text-body><![CDATA[ |
63 |
Affinity / Anti-affinity Rules |
Prachy |
[https://cwiki.apache.org/confluence/display/CLOUDSTACK/Affinity++Anti-affinity+rules- |
|
|
64 |
Granular Global Parameters |
Hari P |
https://issues.apache.org/jira/browse/CLOUDSTACK-741https://issues.apache.org/jira/browse/CLOUDSTACK-741 |
|
|
|
65 |
Support multiple subnets per vlan for KVM HV |
Anthony Xu |
https://issues.apache.org/jira/browse/CLOUDSTACK-788https://issues.apache.org/jira/browse/CLOUDSTACK-788 |
|
|
|
66 |
ApiDiscoverService: Implement a plugin mechanism that exposes the list of APIs through a discovery service on the management server |
Rohit |
|
|
||
67 |
Implement L3 Router functionality in Nicira Nvp Plugin |
Hugo |
|
|
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="346d936b-98b8-40ee-9aa4-06fffd6b0617"><ac:plain-text-body><![CDATA[ |
68 |
Mash up marvin into an interactive auto-completing API shell for CloudStack |
Rohit |
[https://issues.apache.org/jira/browse/CLOUDSTACK-132 |
|
|
69 |
Update Developer Guide |
Radhika |
|
|
|
|
70 |
Release Notes 4.1 |
|
|
|
|
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 40 hours for defect closure.
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
AWS-Style Regions
Status: Research state
Doc impact: Admin Guide, Developer Guide, and Release Notes
Feb 18-22
Overview
Content Tools