Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

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

CLOUDSTACK897
https://issues.apache.org/jira/browse/CLOUDSTACK-702 
https://issues.apache.org/jira/browse/CLOUDSTACK-743  
 https://issues.apache.org/jira/browse/CLOUDSTACK-742

 

 

Feature

Engineering Contacts

Links: Engineering Functional Spec FS+ Doc Bug Number Numbers

Writer

Doc Impact on Documentation

Hours

Writer

Status

1

IP Address reservation within a network

Saksham

2

AWS-style Health Checks

Rajesh Battala

https://cwikiissues.apache.org/confluencejira/displaybrowse/CLOUDSTACK/Load+Balancer+Health+checks
-705

Radhika  

 

JT Done

  2

3

Netscaler LB on Shared VLANs

Rajesh Battala

https://cwiki.apache.org/confluence/display/CLOUDSTACK/LB+on+Shared+VLANs    
CLOUDSTACK-1305

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-    
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 Done

Advanced Search UI

Brian

 

 

 

 

 

4

8

L4-L7 network services in shared network

Murali -

https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network 
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="abd3b6c5-fb22-4f3d-8366-7a557c7b9fc7"><ac:plain-text-body><![CDATA[[  
[https://issues.apache.org/jira/browse/CLOUDSTACK-312
  ]

 

Radhika

On Track

]]></ac:plain-text-body></ac:structured-macro>

 

Done

5 10

User provided hostname to be specified in vCenter -vCenter  
instead of Cloud Platform generated name

Vijay B

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/CLOUDSTACK778CLOUDSTACK-778)  

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.0browse/CLOUDSTACK-779

Radhika

 

Done

9

High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service

Murali

https://cwikiissues.apache.org/confluencejira/display/CLOUDSTACK/Storage+subsystem+2.0- 
CLOUDSTACK-885 

 

 

 

browse/CLOUDSTACK-653

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

Moved to 4.2

14

High Availability: EIP enhancements

Murali

https://issues.apache.org/jira/browse/CLOUDSTACKCLOUDSTACK24-652  
https://issuescwiki.apache.org/jiraconfluence/browse/CLOUDSTACK-652display/CLOUDSTACK/Multiple+IP+address+per+NIC

Radhika

 

Done

15

Multiple IP Ranges

Bharat

https://issues.apache.org/jira/browse/CLOUDSTACK652CLOUDSTACK-702

Radhika

 

In Progress

16

Integrate Cisco ASA 1000v into CloudStack

Kaushik

https://issues.apache.org/jira/browse/CLOUDSTACK-652742

  Radhika

  Radhika

 

17

Integrate Cisco VSG in CloudStack

Kaushik

16

VM's base image update facility (includes Reset a VM on reboot)-

Harikrishna Patnala

https://cwikiissues.apache.org/confluencejira/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+facilityhttps://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility

 

 

 

 

browse/CLOUDSTACK-743

Radhika

 

 

18

Site-to-Site VPN

Sheng

CLOUDSTACK-703  
Monitoring of VPN Tunnels
site-to-site-vpn.html

Radhika

 

 

19

Support multiple subnets per vlan for KVM HV

Anthony

 

Radhika

 

 

20

Delete events and alerts

Sanjay

Doc: CLOUDSTACK-1567
Eng: CLOUDSTACK-874

Radhika

 

Done

21

Dedicated Resources:Limit Resources to domain/accounts

Sanjay

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-  713
 

Radhika

  

Under Review

 

22

Dedicated Resources - Public IP Addresses and VLANs per Tenant

Likitha

21

XenServer updates notifications

Sanjay T

https://issues.apache.org/jira/browse/CLOUDSTACK-192704

  Radhika

  JT

 

23

Advanced Search UI

Brian

 

nTier Apps 2.0 Requirements

Sheng

 

 

 

 

24

Storage subsystem 2.0

Edison

 

 

 

https://cwiki.apache.org/confluence/display/CLOUDSTACK/nTierStorage+Appssubsystem+2.0+RequirementsImage Removed

Radhika

 

24

Support non-contiguous VLAN ranges

Bharat

https://issues.apache.org/jira/browse/CLOUDSTACK-701885

 

 

 

25

VM's base image update facility (includes Reset a VM on reboot)

Hari P

https://issuescwiki.apache.org/jiraconfluence/browsedisplay/CLOUDSTACK-701/Base+Image+Updation+facility

 

 

Radhika

 

26

New Image based provisioning method for Baremetal

Frank

https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+Baremetal

27

Dedicated Resources:

Deepti

Dedicate Pod, Cluster or Host to a domain

 

 

 
https://issues.apache.org/jira/browse/CLOUDSTACK-68140

 

 

 

27 29

XenServer updates notifications

Likitha Sanjay

https://issues.apache.org/jira/browse/CLOUDSTACK-704192

  JT

 

  

28

30

 Dedicated Dedicated Resources:Limit Resources to domain/accounts  Dedicate Pod, Cluster or Host to a domain

Devdeep Sanjay

https://issues.apache.org/jira/browse/CLOUDSTACK-713681

 

 

 

 

32

Specify egress rules on Physical device- 

29

Configurable setting to use linked clones or not on VMware

Vijay Jaypal Reddy-

https://issues.apache.org/jira/browse/CLOUDSTACK-779 

 

 

Radhika

 

33

Health monitoring for load balanced instances

Rajesh

670
https://issuescwiki.apache.org/jiraconfluence/browse/CLOUDSTACK-443 
 display/CLOUDSTACK/Configurable+setting+to+use+linked+clones+or+not+on+VMware

JT

 

 

?

34 30

3rd Party Plugin

Sonny

https://issues.apache.org/jira/browse/CLOUDSTACK-625
 

JT

 

 

 

35

IPv6 Support

Sheng

 

 

 

Radhika

 

31

36

XenMotion Migration

Devdeep  

Doc: CLOUDSTACK-900
Eng: CLOUDSTACK-659
 

JT

 

 

37 32

VMWare Enhancements: Support for DRS, VM HA

Sateesh

 

 

 

 

 

38

VMware vNetwork Distributed Virtual Switch support in CloudStack  

Sateesh

-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 Redddy

 

 

 

 

33

43

Framework for CloudStack to orchestrate virtual network appliances to provide network services  

Murali Reddy

 

 

 

Moved to Future

44

Support VM Snapshot

Mice Mica 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/CLOUDSTACK24
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Multiple+IP+address+per+NIC

 

 

 

 

34

47

CPU/Memory OverCommit

Bharat (XS)
Koushik (VMWare) Rohit (KVM)

https://issues.apache.org/jira/browse/CLOUDSTACK-711 
 

JT

 

JT

 

48 35

SNMP Alerts 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 
 &nbsp;[https://issues.apache.org/jira/browse/CLOUDSTACK-680
]

JT

 

JT

 

49 36

syslog enhancements

Anshul

https://issues.apache.org/jira/browse/CLOUDSTACK-712   

JT

 

  

37

52

Object Store-Integration with CS as secondary Storage

Nitin

https://cwiki.apache.org/confluence/display/CLOUDSTACK/S3-based+secondary+Storage   

JT

  Radhika

 

38

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fc33b7d8-9c06-46b9-bb61-741534720da6"><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 

 

 

724

JT

 

 

 

 

 

 

 

 

 

39

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

 

 

40

 

 

 

56

Integrate Cisco VSG in CloudStack

Koushik Das

 

 

 

 

57

Integrate Cisco ASA 1000v into CloudStack{-}

Koushik Das

 

 

 

 

58

{-}Zone-wide primary storage target

Anthony

https://issues.apache.org/jira/browse/CLOUDSTACK-724 

JT

 

JT

 

59 41

{-}IP Address reservation within a network

Saksham

AWS-style Health Checks

Rajesh

Eng: CLOUDSTACK-443 

 https://issuescwiki.apache.org/jiraconfluence/browsedisplay/CLOUDSTACK-705

 

 

Radhika{-}

/Load+Balancer+Health+checks

JT

 

 

42 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

 

https://issues.apache.org/jira/browse/CLOUDSTACK-669

https://issues.apache.org/jira/browse/CLOUDSTACK-671

JT

 

 

43

Persistent Network Identity

Hari P

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

 

44

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a6d1a3cd-979f-44ff-8c83-ab7e23e9bf88"><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   

JT

 

 

 

64 45

Granular Global Parameters

Hari P

https://issues.apache.org/jira/browse/CLOUDSTACK-741

 

 

  

46

65

Support support multiple subnets per vlan for KVM HV

Anthony Xu Bharat

https://issues.apache.org/jira/browse/CLOUDSTACK-788
https://issues.apache.org/jira/browse/CLOUDSTACK-788

 

 

 

 

47

Mixed zones

Sonny

Doc: CLOUDSTACK-1570
Eng: CLOUDSTACK-738

JT  

 

 

69 48

Update Developer Dev Guide

  Radhika

  

Radhika

 

Radhika

On Track

70 49

Release Notes 4.2

 

 

 

 

jzb

 

71 50

Update Installation Guides

 

 

 

 

 

51

Update API documentation

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  jzb

 

Installation Guides: Update

Each new releases 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. DECISIONS REQUIRED:

...

.

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