Skip to content

Commit 3c35dce

Browse files
author
Gabriel Monroy
committed
Merge pull request #3728 from gabrtv/open-roadmap
Open Roadmap and Planning Process
2 parents ebc3df4 + d7cf4e4 commit 3c35dce

11 files changed

Lines changed: 148 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,23 @@ Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy an
1111

1212
New to Deis? Learn more about Deis [Concepts](http://docs.deis.io/en/latest/understanding_deis/concepts/), [Architecture](http://docs.deis.io/en/latest/understanding_deis/architecture/) and how to [Deploy an Application](http://docs.deis.io/en/latest/using_deis/deploy-application/).
1313

14+
1415
# Installing Deis
1516

1617
Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. Decide where you'd like to deploy Deis, then follow the [provider-specific documentation](http://docs.deis.io/en/latest/installing_deis/) for provisioning.
1718

1819
Trying out Deis? Please follow the documentation on [getting set up with Vagrant](http://docs.deis.io/en/latest/installing_deis/vagrant/).
1920
Upgrading from a previous Deis release? See [Upgrading Deis](http://docs.deis.io/en/latest/managing_deis/upgrading-deis/) for additional information.
2021

21-
## Testing the cluster
22-
23-
Please follow the documentation on [testing Deis](http://docs.deis.io/en/latest/contributing/testing/).
24-
25-
## Hacking on Deis
26-
27-
Learn how to [hack on Deis](http://docs.deis.io/en/latest/contributing/hacking/) with a Docker-based development workflow.
28-
2922
## Troubleshooting
3023

3124
See the [Troubleshooting Deis](http://docs.deis.io/en/latest/troubleshooting_deis/) documentation for
3225
assistance with common issues.
3326

27+
## Contributing
28+
29+
Interested in contributing to Deis? Check out our [Open Roadmap](http://docs.deis.io/en/latest/roadmap/roadmap/) and [Planning Process](http://docs.deis.io/en/latest/roadmap/planning/) or jump right into [hacking on Deis](http://docs.deis.io/en/latest/contributing/hacking/) and [testing your Deis cluster](http://docs.deis.io/en/latest/contributing/testing/).
30+
3431
## License
3532

3633
Copyright 2013, 2014 Engine Yard, Inc.

‎controller/web/static/css/deis-docs.css‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,7 @@ a.viewcode-back {
2626
margin-right: 6px;
2727
vertical-align: super;
2828
}
29+
30+
blockquote {
31+
border-left: none;
32+
}

‎controller/web/static/js/checkURL.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ switch(path) {
3232
case 'customizing_deis':
3333
$('.toctree-l1 > a:contains("Customizing Deis")').attr('state', 'open');
3434
break;
35+
case 'roadmap':
36+
$('.toctree-l1 > a:contains("Roadmap")').attr('state', 'open');
37+
break;
3538
case 'contributing':
3639
$('.toctree-l1 > a:contains("Contributing")').attr('state', 'open');
3740
break;

‎docs/contributing/index.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,3 @@ Contributing
1515
standards
1616
community
1717
conduct
18-
schedule
19-
releases
20-
test_plan

‎docs/roadmap/index.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:title: Roadmap
2+
:description: The Deis roadmap and open source planning process
3+
4+
Roadmap
5+
=======
6+
7+
:Release: |version|
8+
:Date: |today|
9+
10+
.. toctree::
11+
12+
planning
13+
roadmap
14+
schedule
15+
releases
16+
test_plan

‎docs/roadmap/planning.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:title: Planning Process
2+
:description: The open source planning process for the Deis project used to define the roadmap and its execution.
3+
4+
.. _planning:
5+
6+
Planning Process
7+
================
8+
Deis features a lightweight process that emphasizes openness and ensures every community member can be an integral part of planning for the future.
9+
10+
The Role of Maintainers
11+
-----------------------
12+
Maintainers lead the project. Their duties include proposing the Roadmap, reviewing and integrating contributions and maintaining the vision of the project.
13+
14+
Open Roadmap
15+
------------
16+
The :ref:`roadmap` is a community document. While Maintainers propose the Roadmap, it gets discussed and refined in Release Planning Meetings.
17+
18+
Contributing to the Roadmap
19+
---------------------------
20+
Proposals and issues can be opened by anyone. Every member of the :ref:`community` is welcome to participate in the discussion by providing feedback and/or offering counter-proposals.
21+
22+
Release Milestones
23+
------------------
24+
The Roadmap gets delivered progressively via the :ref:`release_schedule`. Releases are defined during Release Planning Meetings and managed using GitHub Milestones which track specific deliverables and work-in-progress.
25+
26+
Release Planning Meetings
27+
-------------------------
28+
Major decisions affecting the Roadmap are discussed during Release Planning Meetings on the first Thursday of each month, aligned with the :ref:`release_schedule`.
29+
30+
Release Planning Meetings are open to the public with access coordinated via the #deis IRC channel on Freenode.
31+
32+
Credits
33+
-------
34+
Thanks to `Amy Lindburg`_ and our friends at `Docker`_ for their inspiration.
35+
36+
.. _`Amy Lindburg`: https://twitter.com/amylindburg
37+
.. _`Docker`: https://www.docker.com/

docs/contributing/releases.rst renamed to docs/roadmap/releases.rst

File renamed without changes.

‎docs/roadmap/roadmap.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
:title: Roadmap
2+
:description: The Deis project roadmap
3+
4+
.. _roadmap:
5+
6+
Deis Roadmap
7+
============
8+
The Deis Roadmap is a community document created as part of the open :ref:`planning`.
9+
Each roadmap item describes a high-level capability or grouping of features that are deemed
10+
important to the future of Deis.
11+
12+
Given the project's rapid :ref:`Release Schedule, <release_schedule>` roadmap items are designed to provide a sense of
13+
direction over many releases.
14+
15+
Update Service
16+
--------------
17+
Deis must support 100% automated, zero-downtime updates of the control plane.
18+
Like CoreOS, Deis clusters should be attached to an alpha, beta or stable channel and rely on an automatic update mechanism.
19+
To accomplish this, Deis plans to use the `Google Omaha Protocol`_ as implemented by `CoreUpdate`_.
20+
21+
- [ ] Update client/agent
22+
- [ ] Update server
23+
- [ ] CI Integration
24+
25+
Scheduling and Orchestration
26+
----------------------------
27+
Today Deis uses `Fleet`_ for scheduling. Unfortunately, Fleet does not support
28+
resource-based scheduling, which results in poor cluster utilization at scale.
29+
30+
Fortunately, Deis is composable and can easily hot-swap orchestration APIs.
31+
Because the most promising container orchestration solutions are under heavy development,
32+
the Deis project is focused on releasing "technology previews".
33+
34+
These technology previews will help the community try different orchestration solutions easily,
35+
report their findings and help guide the future direction of Deis.
36+
37+
- [X] Swarm preview
38+
- [ ] Mesos preview
39+
- [ ] Kubernetes preview
40+
41+
TTY Broker
42+
----------
43+
Today Deis cannot provide bi-directional streams needed for log tailing and interactive batch processes.
44+
By having the :ref:`Controller` drive a TTY Broker component, Deis can securely open WebSockets
45+
through the routing mesh.
46+
47+
- [ ] TTY Broker component
48+
- [ ] Interactive Deis Run (deis run bash)
49+
- [ ] Log Tailing (deis logs -f)
50+
51+
Deis Push
52+
---------
53+
End-users should be able to push Docker-based applications into Deis from their local machine using ``deis push user/app``.
54+
This works around a number of authentication issues with private registries and ``deis pull``.
55+
56+
- [ ] Docker Registry v2
57+
- [ ] Deis Push
58+
59+
Service Broker
60+
--------------
61+
In Deis, connections to :ref:`concepts_backing_services` are meant to be explicit and modeled as a series of environment variables.
62+
Deis believes the Cloud Foundry `Service Broker API`_ is the best embodiment of this today.
63+
64+
- [ ] Deis Addons CLI (deis addons)
65+
- [ ] PostgreSQL Service Broker
66+
- [ ] Redis Service Broker
67+
68+
Monitoring & Telemetry
69+
----------------------
70+
Deis installations today use custom solutions for monitoring, alerting and operational visibility.
71+
Deis will standardize the monitoring interfaces and provide open source agent(s) that can be used to ship telemetry to arbitrary endpoints.
72+
73+
- [ ] Host Telemetry (cpu, memory, network, disk)
74+
- [ ] Container Telemetry (cpu, memory, network, disk)
75+
- [ ] Platform Telemetry (control plane, data plane)
76+
- [ ] Controller Telemetry (app created, build created, containers scaled)
77+
78+
.. _`like CoreOS`: https://coreos.com/releases/
79+
.. _`Google Omaha Protocol`: https://code.google.com/p/omaha/wiki/ServerProtocol
80+
.. _`CoreUpdate`: https://coreos.com/docs/coreupdate/custom-apps/coreupdate-protocol/
81+
.. _`Fleet`: https://github.com/coreos/fleet#readme
82+
.. _`Service Broker API`: http://docs.cloudfoundry.org/services/api.html

docs/contributing/schedule.rst renamed to docs/roadmap/schedule.rst

File renamed without changes.

docs/contributing/test_plan.rst renamed to docs/roadmap/test_plan.rst

File renamed without changes.

0 commit comments

Comments
 (0)