DUE TO SPAM, SIGN-UP IS DISABLED. Goto Selfserve wiki signup and request an account.
Page History
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: Engineering Functional Spec FS+ Bug Numbers | Writer | Doc Impact on Documentation | Hours | Writer | Status | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | IP Address reservation within a network | Saksham | 2 | AWS-style Health Checks | Rajesh Battala | Eng: CLOUDSTACK-443 | https://cwikiissues.apache.org/confluencejira/displaybrowse/CLOUDSTACK/Load+Balancer+Health+checks | Radhika |
| JT Done |
| ||||||||||
3 2 | Netscaler LB on Shared VLANs | Rajesh Battala | https://cwiki.apache.org/confluence/display/CLOUDSTACK/LB+on+Shared+VLANs | Radhika |
|
| Radhika | Moved to 4.2 | |||||||||||||
3 | 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 |
| ||||||||||||||
7 | Advanced Search UI | Brian |
|
|
|
|
| ||||||||||||||
Done | |||||||||||||||||||||
4 | 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 | ]]></ac:plain-text-body></ac:structured-macro> |
| Done | |||||||||||
5 10 | User provided hostname to be specified in vCenter -vCenter | Vijay B | https://issues.apache.org/jira/browse/CLOUDSTACK778 (https://cwiki.apache.org/confluence/display/CLOUDSTACK/- | Radhika |
| Radhika Done | On Track | 13 | Storage subsystem 2.0 | ||||||||||||
6 | High Availability: EIP enhancements | Murali Edison | https://cwikiissues.apache.org/confluencejira/display/CLOUDSTACK/Storage+subsystem+2.0browse/CLOUDSTACK-652 | Radhika |
|
| |||||||||||||||
7 | Support non-contiguous VLAN ranges | Bharat | https://cwikiissues.apache.org/confluencejira/display/CLOUDSTACK/Storage+subsystem+2.0browse/CLOUDSTACK-701 | Radhika |
| in progress | |||||||||||||||
8 | Specify egress rules on Physical device | Jayapal | https://cwikiissues.apache.org/confluencejira/display/CLOUDSTACK/Storage+subsystem+2.0https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0- |
|
|
| Moved to 4.2 | Radhika |
| Done | |||||||||||
9 | High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service | 14 | High Availability: EIP enhancements | Murali | https://issues.apache.org/jira/browse/CLOUDSTACK-652 | Radhika |
|
| |||||||||||||
Radhika 10 | IPv6 Support | Sheng |
| 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 |
|
|
|
| 19 | New Image based provisioning method for Baremetal- | Frank zhang- | https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Baremetal- |||||||||||
| 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 |
|
|
|
| 21 | XenServer updates notifications | Sanjay T | https://issues.apache.org/jira/browse/CLOUDSTACK-192
|
| JT |
| ||||||||
| nTier Apps 2.0 Requirements | Sheng |
|
|
|
|
|
|
| https://cwiki.apache.org/confluence/display/CLOUDSTACK/nTier+Apps+2.0+Requirements | Radhika |
| |||||||||
24 | Support non-contiguous VLAN ranges | Bharat | https://issues.apache.org/jira/browse/CLOUDSTACK-701 |
|
| Radhika |
| 27 | Dedicated Resources: | Deepti | Dedicate Pod, Cluster or Host to a domain |
|
|
| https://issues.apache.org/jira/browse/CLOUDSTACK-681
|
| 29 | Likitha |
|
|
|
| 30 | Dedicated Resources:Limit Resources to domain/accounts | Sanjay | https://issues.apache.org/jira/browse/CLOUDSTACK-713
|
| Radhika |
| 32 | Specify egress rules on Physical device- | Jaypal Reddy | https://issues.apache.org/jira/browse/CLOUDSTACK-779
|
| Radhika |
|
33 | High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service | Murali | Eng: CLOUDSTACK-653 |
|
|
| ? | ||||||||||||||
34 | 3rd Party Plugin | Sonny | https://issues.apache.org/jira/browse/CLOUDSTACK-625- |
|
|
|
| ||||||||||||||
35 | IPv6 Support | Sheng |
|
|
| Radhika |
| ||||||||||||||
36 | XenMotion Migration | Devdeep | Doc: CLOUDSTACK-900 |
|
|
|
| ||||||||||||||
Radhika |
| In Progress | |||||||||||||||||||
16 | Integrate Cisco ASA 1000v into CloudStack | Kaushik | Radhika | 37 | VMWare Enhancements: Support for DRS, VM HA | Sateesh |
|
|
|
|
| ||||||||||
17 | Integrate Cisco VSG | 38 | VMware vNetwork Distributed Virtual Switch support in CloudStack | Sateesh Kaushik | -https://cwikiissues.apache.org/confluencejira/display/CLOUDSTACK/Integration+of+CloudStack+with+VMware+DVS browse/CLOUDSTACK-743 | Radhika |
|
| Radhika |
| |||||||||||
18 | Site-to-Site VPN | Sheng | CLOUDSTACK-703 | Radhika | 42 | ELB: auto-scale request handling capacity by provisioning LB appliances | Murali Redddy |
|
|
|
| ||||||||||
19 | Support multiple subnets per vlan for KVM HV | Anthony |
| Radhika | 43 | Framework for CloudStack to orchestrate virtual network appliances to provide network services | Murali Reddy |
|
| Moved to Future | 44 | Support VM Snapshot | Mice Xia | https://issues.apache.org/jira/browse/CLOUDSTACK-684
|
|
|
| ||||
45 | Persistent Network Identity | Hari P |
|
| JT |
| |||||||||||||||
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 | 46 | Multiple IP Address per NIC | Jaypal | https://issues.apache.org/jira/browse/CLOUDSTACK24CLOUDSTACK- | Radhika |
|
| ||||||||||||
23 | Advanced Search UI | Brian |
|
|
|
| |||||||||||||||
24 | Storage subsystem 2.0 | Edison | https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0 | 47 | CPU/Memory OverCommit | Bharat (XS) |
| JT |
| ||||||||||||
25 | VM's base image update facility (includes Reset a VM on reboot) | Hari P | 48 | SNMP Alerts | Anshul | https://issuescwiki.apache.org/jiraconfluence/browsedisplay/CLOUDSTACK-680 |
|
|
| ||||||||||||
26 | New Image based provisioning method for Baremetal | Frank | https://cwiki.apache.org/confluence/display/CLOUDSTACK/FS+for+Integrating+CS+alerts+via+SNMP+to+external+management+system |
|
| JT |
| 49 | syslog enhancements | Anshul | CloudStack+Baremetal |
|
|
|
| ||||||
27 | XenServer updates notifications | Sanjay | 52 | Object Store-Integration with CS as secondary Storage | Nitin | https://cwikiissues.apache.org/confluencejira/displaybrowse/CLOUDSTACK/S3-based+secondary+Storage |
|
| Jessica T |
| JT |
|
| ||||||||
28 | Dedicated Resources: Dedicate Pod, Cluster or Host to a domain | Devdeep | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a3b189b8-a037-4364-885f-b3489ce83b6f"><ac:plain-text-body><![CDATA[ | 53 | Zone-wide (primary) Block Storage | Edison |
|
|
| ||||||||||||
29 | Configurable setting to use linked clones or not on VMware | Vijay | https://issues.apache.org/jira/browse/CLOUDSTACK-670 |
|
| JT |
|
|
|
|
| JT |
|
| |||||||
30 | 53 | Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs)- | Nitin Mehta | 3rd Party Plugin | Sonny | -https://issues.apache.org/jira/browse/CLOUDSTACK-658 | JT |
|
| ||||||||||||
31 | XenMotion Migration |
| Doc: CLOUDSTACK-900 | JT |
|
| |||||||||||||||
32 | VMWare Enhancements: Support for DRS, VM HA | Sateesh | https://cwiki.apache.org/confluence/display/CLOUDSTACK/DynamicIntegration+scalingof+ofCloudStack+CPUwith+andVMware+RAM DVS |
| JT |
| |||||||||||||||
33 | Support VM Snapshot | Mica Xia | 55 | Multiple IP Ranges | Bharat | https://issues.apache.org/jira/browse/CLOUDSTACK-702 684; |
|
|
|
| |||||||||||
34 | CPU/Memory OverCommit | Bharat | 56 | Integrate Cisco VSG in CloudStack | Koushik Das | JT |
|
| |||||||||||||
35 | 57 | Integrate Cisco ASA 1000v into CloudStack{-} | Koushik Das | SNMP Alerts | Anshul | https://issues.apache.org/jira/browse/CLOUDSTACK-680 https://issuescwiki.apache.org/jiraconfluence/browse/CLOUDSTACK-742 |
|
|
|
| 58 | {-}Zone-wide primary storage target | Anthony | display/CLOUDSTACK/FS+for+Integrating+CS+alerts+via+SNMP+to+external+management+system [https://issues.apache.org/jira/browse/CLOUDSTACK-724- 680 |
| JT |
| 59 | {-}IP Address reservation within a network | Saksham | |
36 | syslog enhancements | Anshul |
|
| Radhika{-} | - | 60 | Volume snapshot enhancements for VMware + Better VM Sync{-} | Kelven Yang | https://cwikiissues.apache.org/confluencejira/displaybrowse/CLOUDSTACK/VMWare+Enhancements+-+Support+for+DRS+and+VM+HA- |
| JT |
|
| |||||||
37 | Object Store-Integration with CS as secondary Storage | Nitin | https://issuescwiki.apache.org/jiraconfluence/browsedisplay/CLOUDSTACK-669 | JT | JT |
| 61 | Configurable setting to use linked clones or not on VMware | |||||||||||||
38 | Zone-wide (primary) Block Storage | Edison | Vijay B | JT |
|
| |||||||||||||||
39 | Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs) | Nitin | |
|
| JT |
| JT |
|
| |||||||||||
40 | Zone-wide primary storage target | Anthony | JT |
|
| ||||||||||||||||
41 | AWS-style Health Checks | Rajesh | Eng: CLOUDSTACK-443 | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c09c6946-f553-47e9-9f1e-e20c972f4d96"><ac:plain-text-body><![CDATA[ | 63 | Affinity / Anti-affinity Rules- | Prachy | [https://cwiki.apache.org/confluence/display/CLOUDSTACK/AffinityLoad+Balancer++Anti-affinity+rules | JT |
|
| ||||||||||
42 | Volume snapshot enhancements for VMware + Better VM Sync | Kelven Yang | https://issuescwiki.apache.org/jiraconfluence/browse/CLOUDSTACK-739 display/CLOUDSTACK/VMWare+Enhancements-Support+for+DRS+and+VM+HA- | JT |
|
| |||||||||||||||
43 | Persistent Network Identity | Hari P |
|
|
|
| |||||||||||||||
44 | Affinity / Anti-affinity Rules | Prachy | 64 | Granular Global Parameters | Hari P | JT |
|
|
| ||||||||||||
45 | Granular Global Parameters | Hari P | 65 | Support multiple subnets per vlan for KVM HV | Anthony Xu |
|
|
|
| ||||||||||||
46 | support multiple subnets per vlan | Bharat | 66 | Site-to-Site VPN: Monitoring of VPN Tunnels | Sheng | CLOUDSTACK-703 |
|
| Radhika | ||||||||||||
Done 47 | 67 | Delete events and alerts | Mixed zones | Sonny Sanjay | Doc: CLOUDSTACK-15671570 | JT |
|
| |||||||||||||
48 | Update Dev Guide | 68 Radhika | Mixed zones | Sonny Radhika |
| On Track | |||||||||||||||
49 | Release Notes 4.2 |
|
|
|
|
| |||||||||||||||
50 | Update Installation Guides |
| Doc: CLOUDSTACK-1570 | If the UI is affected, there could be doc changes. |
| Jessica T |
| 69 | Update Developer Guide |
|
|
|
| ||||||||
51 | Update API documentation |
|
|
|
|
| Radhika | On Track | 70 | Release Notes 4.2 | |||||||||||
|
|
|
| jzb |
| 71 | |||||||||||||||
Update Installation Guides |
|
|
|
| jzb |
|
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