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\\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network
|
Radhika |
|
|
4 |
F5 & SRX inline mode |
Sheng |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Network+inline+mode+functional+spec 
; |
Radhika |
|
|
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
|
|
|
|
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
|
|
|
|
9 |
S3-backed Secondary Storage |
John Burwell |
https://issues.apache.org/jira/browse/CLOUDSTACK-509
|
|
|
|
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 |
|
|
|
11 |
EC2 Query API support |
Likitha |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/EC2++-+Functional+Spec+for+Query+API+support
|
|
|
|
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 |
|
|
||
15 |
High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service |
Murali |
https://issues.apache.org/jira/browse/CLOUDSTACK-653 |
https://issues.apache.org/jira/browse/CLOUDSTACK-653\\
|
|
|
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\\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Enhanced+Baremetal+support+on+Cisco+UCS\\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Cisco+UCS+Integration+functional+spec\\ |
|
|
|
18 |
Events framework to publish/subscribe to CloudStack events |
Murali |
https://issues.apache.org/jira/browse/CLOUDSTACK-820\\ |
|
|
|
19 |
New Image based provisioning method for Baremetal |
Frank zhang |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Baremetal\\
https://issues.apache.org/jira/browse/CLOUDSTACK-40\\ |
|
|
|
20 |
OVS support in KVM |
Hugo |
https://issues.apache.org/jira/browse/CLOUDSTACK-101\\ |
Hugo |
|
|
21 |
XenServer updates notifications |
Sanjay T |
https://issues.apache.org/jira/browse/CLOUDSTACK-192\\ |
JT |
|
|
22 |
Reset SSH Key to access VM (similar to reset password) |
Harikrishna Patnala |
https://issues.apache.org/jira/browse/CLOUDSTACK-297 |
JT |
|
|
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 |
|
|
26 |
Site-to-Site VPN 2.0 |
|
Radhika |
|
||
27 |
Dedicated Resources: |
Deepti |
[https://issues.apache.org/jira/browse/CLOUDSTACK-681 ] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Private+Host%2C+Cluster%2C+Pod\ |
|
|
|
28 |
Dedicated Resources: Persistent Networks without running a VM |
Likitha |
[https://issues.apache.org/jira/browse/CLOUDSTACK-706] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Persistent+Networks\ |
|
|
|
29 |
Dedicated Resources: |
Sanjay Tripathi |
[https://issues.apache.org/jira/browse/CLOUDSTACK-713] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Limit+Resources+to+domains+and+accounts\ |
|
|
|
30 |
Egress firewall rules for guest network |
Jaypal Reddy |
https://issues.apache.org/jira/browse/CLOUDSTACK-299 |
Radhika |
|
|
31 |
Health monitoring for load balanced instances |
Rajesh |
https://issues.apache.org/jira/browse/CLOUDSTACK-443\\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Load+Balancer+Health+checks |
|
|
|
32 |
|
|
|
|
|
|
11 |
IPv6 Support |
Sheng |
|
Radhika |
|
|
12 |
Storage XenMotion/Migration |
Devdeep |
https://issues.apache.org/jira/browse/CLOUDSTACK-659
|
|
|
|
13 |
VMWare Enhancements: Support for DRS, VM HA |
Sateesh |
Radhika |
|
||
14 |
Support VMware DVSwitch |
Sateesh |
Radhika |
|
||
15 |
VM Reset (Reset-on-boot) |
Hari P |
Feature: Specify VM shutdown behavior (destroy, restart with a new boot drive) |
JT |
|
|
16 |
Persistent Network Identity |
Hari P |
JT |
|
||
17 |
Multiple IP Address per NIC |
Jaypal |
https://issues.apache.org/jira/browse/CLOUDSTACK-24 |
Radhika |
|
|
18 |
CPU/Memory OverCommit |
Bharat (XS) |
JT |
|
||
19 |
Monitoring |
Anshul |
[https://issues.apache.org/jira/browse/CLOUDSTACK-680][https://cwiki.apache.org/confluence/display/CLOUDSTACK/FS+for+Integrating+CS+alerts+via+SNMP+to+external+management+system] |
JT |
|
|
20 |
Limit API Queries (CLOUDSTACK-618) |
Min Chen |
JT |
|
||
21 |
Improve API Performance / Add Search Capabilities |
Min Chen |
JT |
|
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="48d5dac4-4128-4823-9fb9-d47e953e1cca"><ac:plain-text-body><![CDATA[ |
22 |
Object Store-Integration with CS as secondary Storage |
Nitin |
[https://cwiki.apache.org/confluence/display/CLOUDSTACK/S3-based+secondary+Storage |
Radhika |
|
23 |
EBS Shared NFS Zone-wide (primary) Block Storage |
Anthony |
JT |
|
||
24 |
Raise cluster size limit to 16 |
Koushik |
JT |
|
||
25 |
Dynamic Resource Scaling |
Nitin Mehta |
JT |
|
||
26 |
Events framework to publish/subscribe to CloudStack events |
Murali |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Event+Notification+Framework+Proposal|../../../../../../../../../display/CLOUDSTACK/Event+Notification+Framework+Proposal||\ |
JT |
|
|
27 |
Integrate Cisco VSG in CloudStack |
Koushik Das |
|
|
||
28 |
Integrate Cisco ASA 1000v into CloudStack |
Koushik Das |
|
|
||
29 |
Zone-wide primary storage target |
Anthony |
JT |
|
||
30 |
IP Address reservation within a network |
Saksham |
Radhika |
|
||
31 |
Volume snapshot enhancements for VMware |
Kelven Yang |
JT |
|
||
32 |
Configurable setting to use linked clones or not on VMware |
Vijay |
JT |
|
||
33 |
VM's base image update facility |
Hari P |
JT |
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installation Guides: Update
Each new releases requires an update of the existing Installation Guide. A major rewrite is required for "build from source" installation procedure.
Release Notes
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. 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.
- Set up documentation repos related to Apache project incubation for non-committers
- Set up tools to build and publish documentation sets on a new doc website
- Community outreach activities: presentations at professional gatherings, presence on mailing lists and social media, organizing CloudStack meetups,
Overview
Content Tools