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 + Doc Bug Number	Writer	Status
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 CLOUDSTACK-1305+	Radhika	Moved to 4.2
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- https://cwiki.apache.org/confluence/display/CLOUDSTACK/Optional+Public+IP+assignment+for+EIP+with+Basic+Zone- https://issues.apache.org/jira/browse/CLOUDSTACK-265-	Radhika
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 -https://issues.apache.org/jira/browse/CLOUDSTACK-312	Radhika	On Track
10	User provided hostname to be specified in vCenter - instead of Cloud Platform generated name-	Vijay B	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/CLOUDSTACK778-	Radhika	On Track
13	Storage subsystem 2.0	Edison	https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0- CLOUDSTACK-885		Moved to 4.2
14	High Availability: EIP enhancements	Murali	https://issues.apache.org/jira/browse/CLOUDSTACK-652https://issues.apache.org/jira/browse/CLOUDSTACK652	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 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility 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- https://issues.apache.org/jira/browse/CLOUDSTACK-40-
21	XenServer updates notifications	Sanjay T	https://issues.apache.org/jira/browse/CLOUDSTACK-192	JT

23	nTier Apps 2.0 Requirements	Sheng + Kishan Kavala	https://issues.apache.org/jira/browse/CLOUDSTACK-621 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-701https://issues.apache.org/jira/browse/CLOUDSTACK-701	Radhika
27	Dedicated Resources: Dedicate Pod, Cluster or Host to a domain	Deepti	https://issues.apache.org/jira/browse/CLOUDSTACK-681
29	Dedicated Resources - Public IP Addresses and VLANs per Tenant	Likitha	https://issues.apache.org/jira/browse/CLOUDSTACK-704
30	Dedicated Resources:Limit Resources to domain/accounts	Sanjay Tripathi	https://issues.apache.org/jira/browse/CLOUDSTACK-713
32	Specify egress rules on Physical device	Jaypal Reddy	https://issues.apache.org/jira/browse/CLOUDSTACK-779	Radhika
33	Health monitoring for load balanced instances	Rajesh	https://issues.apache.org/jira/browse/CLOUDSTACK-443	?	?
34	3rd Party Plugin	Sonny	-https://issues.apache.org/jira/browse/CLOUDSTACK-625- https://cwiki.apache.org/confluence/display/CLOUDSTACK/3rd+Party+Plugin
35	IPv6 Support	Sheng	?	Radhika
36	Storage XenMotion/Migration	Devdeep	https://issues.apache.org/jira/browse/CLOUDSTACK-659 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Enabling+Storage+XenMotion+for+XenServer
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 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Integration+of+CloudStack+with+VMware+DVS	Radhika
42	ELB: auto-scale request handling capacity by provisioning LB appliances	Murali Reddy	https://issues.apache.org/jira/browse/CLOUDSTACK-654
43	Framework for CloudStack to orchestrate virtual network appliances to provide network services	Murali Reddy	CLOUDSTACK-897		Moved to Future
44	Support VM Snapshot	Mice Xia	https://issues.apache.org/jira/browse/CLOUDSTACK-684
45	Persistent Network Identity	Hari P	http://mindtouch.citrite.net/Releases/Merlin/Features/CloudStack_and_AWS_Support/CloudStack_Feature_Requests	JT
46	Multiple IP Address per NIC	Jaypal	https://issues.apache.org/jira/browse/CLOUDSTACK-24 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Multiple+IP+address+per+NIC	Radhika
47	CPU/Memory OverCommit	Bharat (XS) Koushik (VMWare) Rohit (KVM)	https://issues.apache.org/jira/browse/CLOUDSTACK-711	JT
48	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
49	syslog enhancements	Anshul	https://issues.apache.org/jira/browse/CLOUDSTACK-712
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="0e72857a-85e9-46fa-b74e-ce53d775d1a1"><ac:plain-text-body><![CDATA[	53	Zone-wide (primary) Block Storage	Edison	[https://issues.apache.org/jira/browse/CLOUDSTACK-724 ]]></ac:plain-text-body></ac:structured-macro> ]https://cwiki.apache.org/confluence/display/CLOUDSTACK/Zone-wide+primary+storage+target	JT

53	Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs)	Nitin Mehta	https://issues.apache.org/jira/browse/CLOUDSTACK-658 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Dynamic+scaling+of+CPU+and+RAM	JT
55	Multiple IP Ranges	Bharat	https://issues.apache.org/jira/browse/CLOUDSTACK-702
56	Integrate Cisco VSG in CloudStack	Koushik Das	https://issues.apache.org/jira/browse/CLOUDSTACK-743
57	Integrate Cisco ASA 1000v into CloudStack	Koushik Das	https://issues.apache.org/jira/browse/CLOUDSTACK-742
58	Zone-wide primary storage target	Anthony	https://issues.apache.org/jira/browse/CLOUDSTACK-724	JT
59	IP Address reservation within a network	Saksham	https://issues.apache.org/jira/browse/CLOUDSTACK-705	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- https://issues.apache.org/jira/browse/CLOUDSTACK-669 https://issues.apache.org/jira/browse/CLOUDSTACK-671	JT
61	Configurable setting to use linked clones or not on VMware	Vijay B	-https://issues.apache.org/jira/browse/CLOUDSTACK-670- -https://cwiki.apache.org/confluence/display/CLOUDSTACK/Configurable+setting+to+use+linked+clones+or+not+on+VMware- https://cwiki.apache.org/confluence/display/CLOUDSTACK/Provide+full+clone+support+for+guest+VMs+on+VMWare+deployments+in+Cloudstack	JT
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2570286b-677b-4b6a-9de6-2acc920013e6"><ac:plain-text-body><![CDATA[	63	Affinity / Anti-affinity Rules	Prachy	[https://cwiki.apache.org/confluence/display/CLOUDSTACK/Affinity++Anti-affinity+rules- ]]></ac:plain-text-body></ac:structured-macro> ]https://issues.apache.org/jira/browse/CLOUDSTACK-739
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
69	Update Developer Guide			Radhika	On Track
70	Release Notes 4.2			jzb
71	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.

What's this?

Details on the documentation needs for ACS 4.2.