You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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
https://issues.apache.org/jira/browse/CLOUDSTACK-700

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

 

6

AutoScale

Vijay

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Autoscaling
https://issues.apache.org/jira/browse/CLOUDSTACK-637

 

 

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

 

 

9

S3-backed Secondary Storage

John Burwell

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

 

 

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/CLOUDSTACK-778

 

 

11

EC2 Query API support

Likitha

https://cwiki.apache.org/confluence/display/CLOUDSTACK/EC2++-+Functional+Spec+for+Query+API+support
https://issues.apache.org/jira/browse/CLOUDSTACK-197

 

 

12

API Request Throttling

Min

https://cwiki.apache.org/confluence/display/CLOUDSTACK/API+Request+Throttling
https://issues.apache.org/jira/browse/CLOUDSTACK-618

 

 

13

Storage subsystem 2.0

Edison

https://issues.apache.org/jira/browse/CLOUDSTACK-629
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0

 

 

14

High Availability: EIP enhancements

Murali

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

 

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ee13d17b-f515-41bd-b8df-9520a673e786"><ac:plain-text-body><![CDATA[

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
]]></ac:plain-text-body></ac:structured-macro>
]]
https://cwiki.apache.org/confluence/display/CLOUDSTACK/GSLB+%28Global+Server+Load+Balancing%29+Functional+specification+and+Design+DocumentX

 

 

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

 

25

Security Groups Isolation in Advanced Zone

Anthony

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

JT

 

26

Site-to-Site VPN 2.0

Sheng

https://issues.apache.org/jira/browse/CLOUDSTACK-703\\

Radhika

 

27

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

 Deepti

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

 

 

28

Dedicated Resources: Persistent Networks without running a VM

Likitha

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

 

 

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
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Limit+Resources+to+domains+and+accounts|../../../../../../../../../display/CLOUDSTACK/Limit+Resources+to+domains+and+accounts\ 

 

 

31

Egress firewall rules for guest network

Jaypal Reddy

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

Radhika

 

32

Specify egress rules on VR

Jaypal Reddy

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



 

 

33

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|../../../../../../../../../display/CLOUDSTACK/Load+Balancer+Health+checks\ 

 

 

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

 

Radhika

 

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

 

39

Additional VMX Settings

Vijay B

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



 

 

40

Resize volumes feature

Marcus Sorensen

https://issues.apache.org/jira/browse/CLOUDSTACK-644\\

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Resize+Data+Volumes



JT

 

41

Add/remove network on VM

Marcus Sorensen

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


https://cwiki.apache.org/confluence/display/CLOUDSTACK/Add+Remove+Networks+to+VMs|../../../../../../../../../display/CLOUDSTACK/Add+Remove+Networks+to+VMs\ 

 

 

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

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



 

 

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


https://cwiki.apache.org/confluence/display/CLOUDSTACK/CPU+and+Memory+OverCommit|../../../../../../../../../display/CLOUDSTACK/CPU+and+Memory+OverCommit\ 

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



 

 

 

Limit API Queries (CLOUDSTACK-618)

Min Chen

 

JT

 

 

Improve API Performance / Add Search Capabilities
(CLOUDSTACK-527)

Min Chen

 

JT

 

50

Object Store-Integration with CS as secondary Storage

Nitin

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

Radhika

 

51

Zone-wide (primary) Block Storage

Edison

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

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Zone-wide+primary+storage+target



JT

 

52

Raise cluster size limit to 16

Koushik

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

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

 

54

Allow for same vlan on different physical nics

Kishan Kavala

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



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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7ab6cf0d-61d6-4361-b6ca-957fc72b716a"><ac:plain-text-body><![CDATA[ https://issues.apache.org/jira/browse/CLOUDSTACK-669
][https://issues.apache.org/jira/browse/CLOUDSTACK-671
]]></ac:plain-text-body></ac:structured-macro>

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

 

62

BigSwitch network plugin

Kanzhe Jiang

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



JT

 

63

Affinity / Anti-affinity Rules

Prachy

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Affinity+-+Anti-affinity+rules\\

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



 

 

64

Granular Global Parameters

Hari P

https://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-788

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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,
  • No labels