What's this?
Details on the documentation needs for ACS 4.2.
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.2 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 |
Links: FS+ Bug Numbers |
Writer |
Doc Impact |
Status |
|---|---|---|---|---|---|---|
1 |
IP Address reservation within a network |
Saksham |
Radhika |
|
Done |
|
2 |
Netscaler LB on Shared VLANs |
Rajesh |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/LB+on+Shared+VLANs |
Radhika |
|
|
3 |
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 |
|
Done |
4 |
L4-L7 network services in shared network |
Murali |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network |
Radhika |
|
Done |
5 |
User provided hostname to be specified in vCenter |
Vijay |
https://issues.apache.org/jira/browse/CLOUDSTACK778 (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Allow+user+provided+hostname%2C+internal+VM+name+on+hypervisor+for+guest+VMs\\]https://issues.apache.org/jira/browse/CLOUDSTACK-778) |
Radhika |
|
Done |
6 |
High Availability: EIP enhancements |
Murali |
Radhika |
|
|
|
7 |
Support non-contiguous VLAN ranges |
Bharat |
Radhika |
|
in progress |
|
8 |
Specify egress rules on Physical device |
Jayapal |
Radhika |
|
Done |
|
9 |
High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service |
Murali |
Radhika |
|
|
|
10 |
IPv6 Support |
Sheng |
|
Radhika |
|
APIs are done |
11 |
nTier Apps 2.0 Requirements |
Kishan/Sheng |
|
Radhika |
|
|
12 |
VMware vNetwork Distributed Virtual Switch support in CloudStack |
Sateesh |
|
Radhika |
|
under review |
13 |
Framework for CloudStack to orchestrate virtual network appliances to provide network services |
Murali |
|
Radhika |
|
|
14 |
Multiple IP Address per NIC |
Jaypal |
https://issues.apache.org/jira/browse/CLOUDSTACK24- |
Radhika |
|
Done |
15 |
Multiple IP Ranges |
Bharat |
Radhika |
|
In Progress |
|
16 |
Integrate Cisco ASA 1000v into CloudStack |
Kaushik |
Radhika |
|
|
|
17 |
Integrate Cisco VSG in CloudStack |
Kaushik |
Radhika |
|
|
|
18 |
Site-to-Site VPN |
Sheng |
CLOUDSTACK-703 |
Radhika |
|
|
19 |
Support multiple subnets per vlan for KVM HV |
Anthony |
|
Radhika |
|
|
20 |
Delete events and alerts |
Sanjay |
Doc: CLOUDSTACK-1567 |
Radhika |
|
Done |
21 |
Dedicated Resources:Limit Resources to domain/accounts |
Sanjay |
Radhika |
|
Under Review |
|
22 |
Dedicated Resources - Public IP Addresses and VLANs per Tenant |
Likitha |
Radhika |
|
|
|
23 |
Advanced Search UI |
Brian |
|
|
|
|
24 |
Storage subsystem 2.0 |
Edison |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0 |
|
|
|
25 |
VM's base image update facility (includes Reset a VM on reboot) |
Hari P |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility |
|
|
|
26 |
New Image based provisioning method for Baremetal |
Frank |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Baremetal |
|
|
|
27 |
XenServer updates notifications |
Sanjay |
JT |
|
|
|
28 |
Dedicated Resources: Dedicate Pod, Cluster or Host to a domain |
Devdeep |
|
|
|
|
29 |
Configurable setting to use linked clones or not on VMware |
Vijay |
https://issues.apache.org/jira/browse/CLOUDSTACK-670 |
JT |
|
|
30 |
3rd Party Plugin |
Sonny |
JT |
|
|
|
31 |
XenMotion Migration |
|
Doc: CLOUDSTACK-900 |
JT |
|
|
32 |
VMWare Enhancements: Support for DRS, VM HA |
Sateesh |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Integration+of+CloudStack+with+VMware+DVS |
|
|
|
33 |
Support VM Snapshot |
Mica Xia |
|
|
|
|
34 |
CPU/Memory OverCommit |
Bharat |
JT |
|
|
|
35 |
SNMP Alerts |
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 [https://issues.apache.org/jira/browse/CLOUDSTACK-680 |
JT |
|
|
36 |
syslog enhancements |
Anshul |
JT |
|
|
|
37 |
Object Store-Integration with CS as secondary Storage |
Nitin |
https://cwiki.apache.org/confluence/display/CLOUDSTACK/S3-based+secondary+Storage |
JT |
|
|
38 |
Zone-wide (primary) Block Storage |
Edison |
JT |
|
|
|
39 |
Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs) |
Nitin |
https://issues.apache.org/jira/browse/CLOUDSTACK-658 |
JT |
|
|
40 |
Zone-wide primary storage target |
Anthony |
JT |
|
|
|
41 |
AWS-style Health Checks |
Rajesh |
Eng: CLOUDSTACK-443 |
JT |
|
|
42 |
Volume snapshot enhancements for VMware + Better VM Sync |
Kelven Yang |
JT |
|
|
|
43 |
Persistent Network Identity |
Hari P |
|
|
|
|
44 |
Affinity / Anti-affinity Rules |
Prachy |
JT |
|
|
|
45 |
Granular Global Parameters |
Hari P |
|
|
|
|
46 |
support multiple subnets per vlan |
Bharat |
|
|
|
|
47 |
Mixed zones |
Sonny |
Doc: CLOUDSTACK-1570 |
JT |
|
|
48 |
Update Dev Guide |
Radhika |
|
Radhika |
|
On Track |
49 |
Release Notes 4.2 |
|
|
|
|
|
50 |
Update Installation Guides |
|
|
|
|
|
51 |
Update API documentation |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installation Guides: Update
Each new release 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.
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
March 25-29
dvSwitch: incorporating comments (Radhika)
Delete events and alerts: research (Radhika)
SNMP Alerts: write overview (Jessica)
S3 secondary storage: investigation (Jessica)
VM snapshots (VMware only for now): write overview (Jessica)
April 1 - 5
Multiple IP addresses per NIC: done (Radhika)
Limit resources to domains/accounts: done (Radhika)
Regions, AWS-Style: review and approval (Jessica)
Health monitoring for NetScaler load balanced instances: write overview (Jessica)
S3 secondary storage: write (Jessica)
April 8 - 12
S3 secondary storage: write (Jessica)
Limit resources to domains/accounts: review (Radhika)
dvSwitch - first review comments are incorporated. Queries are awaiting answers (Radhika)
April 15 - 19
Radhika: vacation
Cisco UCS baremetal: write overview (Jessica)
April 22 - 26
Document Support non-contiguous VLAN ranges (Radhika)
Delete events and alerts: done (Radhika)
April 28 - May 3
Dedicated Resources - Public IP Addresses and VLANs per Tenant (Radhika) (research)
Multiple IP Ranges (research)
May 6 - May 11
Overview
Content Tools
Apps