Skip to content

Commit dc0e22b

Browse files
committed
docs(roadmap): link roadmap items to GitHub issues
1 parent 48ff779 commit dc0e22b

1 file changed

Lines changed: 45 additions & 12 deletions

File tree

docs/roadmap/roadmap.rst

Lines changed: 45 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,17 @@ Ceph should be optional, especially for users on AWS with direct access to servi
2222
- [ ] Database S3 configuration
2323
- [ ] Stateless logger (in-memory ring buffer)
2424

25+
This feature is tracked as GitHub issue `#2812`_.
26+
2527
TTY Broker
2628
----------
2729
Today Deis cannot provide bi-directional streams needed for log tailing and interactive batch processes.
2830
By having the :ref:`Controller` drive a TTY Broker component, Deis can securely open WebSockets
2931
through the routing mesh.
3032

31-
- [ ] TTY Broker component
32-
- [ ] Interactive Deis Run (deis run bash)
33-
- [ ] Log Tailing (deis logs -f)
33+
- [ ] `TTY Broker component`_
34+
- [ ] `Interactive Deis Run`_ (``deis run bash``)
35+
- [ ] `Log Tailing`_ (``deis logs -f``)
3436

3537
Scheduling and Orchestration
3638
----------------------------
@@ -45,28 +47,33 @@ These technology previews will help the community try different orchestration so
4547
report their findings and help guide the future direction of Deis.
4648

4749
- [X] Swarm preview
48-
- [ ] Mesos preview
49-
- [ ] Kubernetes preview
50+
- [ ] `Mesos preview`_
51+
- [ ] `Kubernetes preview`_
5052

5153
Networking v2
5254
-------------
5355
To provide a better container networking experience, Deis must provide an overlay network
5456
that can facilitate SDN and improved service discovery.
5557

5658
- [ ] Overlay Network
57-
- [ ] Internal Service Discovery
59+
- [ ] `Internal Service Discovery`_
5860
- [ ] Migration Strategy
5961

62+
This feature is tracked as GitHub issue `#3812`_.
63+
6064
Update Service
6165
--------------
6266
Deis must support 100% automated, zero-downtime updates of the control plane.
6367
Like CoreOS, Deis clusters should be attached to an alpha, beta or stable channel and rely on an automatic update mechanism.
6468
To accomplish this, Deis plans to use the `Google Omaha Protocol`_ as implemented by `CoreUpdate`_.
6569

66-
- [ ] Update client/agent
70+
- [ ] `Update client/agent`_
6771
- [ ] Update server
72+
- [ ] `Automatic CoreOS upgrades`_
6873
- [ ] CI Integration
6974

75+
This feature is tracked as GitHub issue `#2106`_.
76+
7077
Etcd 2
7178
------
7279
A CP database like etcd is central to Deis, which requires a distributed lock service and key/value store.
@@ -75,22 +82,27 @@ As problems with etcd directly impact platform stability, Deis must move to the
7582
- [ ] Switch to etcd2
7683
- [ ] Migration strategy for etcd 0.4.x -> etcd2
7784

85+
This feature is tracked as GitHub issue `#3564`_.
86+
7887
User-defined Health Checks
7988
--------------------------
8089
Today Deis relies on TCP port checks as evidence of container readiness during deploys.
8190
To facilitate a better zero-downtime deploy experience, Deis should allow user-defined
82-
health checks that are respected during the rolling deploy process.
91+
health checks that are respected during the rolling deploy process and to verify that containers
92+
are healthy before publishing them to the routing mesh.
8393

8494
- [ ] HealthCheck API and CLI
8595
- [ ] Publisher / HealthCheck integration
8696

97+
This feature is tracked as GitHub issue `#3813`_.
98+
8799
Deis Push
88100
---------
89101
End-users should be able to push Docker-based applications into Deis from their local machine using ``deis push user/app``.
90102
This works around a number of authentication issues with private registries and ``deis pull``.
91103

92-
- [ ] Docker Registry v2
93-
- [ ] Deis Push
104+
- [ ] `Docker Registry v2`_
105+
- [ ] `Deis Push`_
94106

95107
Service Broker
96108
--------------
@@ -101,6 +113,8 @@ Deis believes the Cloud Foundry `Service Broker API`_ is the best embodiment of
101113
- [ ] PostgreSQL Service Broker
102114
- [ ] Redis Service Broker
103115

116+
This feature is tracked as GitHub issue `#231`_.
117+
104118
Monitoring & Telemetry
105119
----------------------
106120
Deis installations today use custom solutions for monitoring, alerting and operational visibility.
@@ -111,8 +125,27 @@ Deis will standardize the monitoring interfaces and provide open source agent(s)
111125
- [ ] Platform Telemetry (control plane, data plane)
112126
- [ ] Controller Telemetry (app created, build created, containers scaled)
113127

114-
.. _`like CoreOS`: https://coreos.com/releases/
115-
.. _`Google Omaha Protocol`: https://code.google.com/p/omaha/wiki/ServerProtocol
128+
This feature is tracked as GitHub issue `#3699`_.
129+
130+
.. _`#231`: https://github.com/deis/deis/issues/231
131+
.. _`#2106`: https://github.com/deis/deis/issues/2106
132+
.. _`#2812`: https://github.com/deis/deis/issues/2812
133+
.. _`#3564`: https://github.com/deis/deis/issues/3564
134+
.. _`#3699`: https://github.com/deis/deis/issues/3699
135+
.. _`#3812`: https://github.com/deis/deis/issues/3812
136+
.. _`#3813`: https://github.com/deis/deis/issues/3813
137+
.. _`Automatic CoreOS upgrades`: https://github.com/deis/deis/issues/1043
116138
.. _`CoreUpdate`: https://coreos.com/docs/coreupdate/custom-apps/coreupdate-protocol/
139+
.. _`Deis Push`: https://github.com/deis/deis/issues/2680
140+
.. _`Docker Registry v2`: https://github.com/deis/deis/issues/3814
117141
.. _`Fleet`: https://github.com/coreos/fleet#readme
142+
.. _`Google Omaha Protocol`: https://code.google.com/p/omaha/wiki/ServerProtocol
143+
.. _`Interactive Deis Run`: https://github.com/deis/deis/issues/117
144+
.. _`Internal Service Discovery`: https://github.com/deis/deis/issues/3072
145+
.. _`Kubernetes preview`: https://github.com/deis/deis/issues/2744
146+
.. _`like CoreOS`: https://coreos.com/releases/
147+
.. _`Log Tailing`: https://github.com/deis/deis/issues/465
148+
.. _`Mesos preview`: https://github.com/deis/deis/issues/3809
118149
.. _`Service Broker API`: http://docs.cloudfoundry.org/services/api.html
150+
.. _`TTY Broker component`: https://github.com/deis/deis/issues/3808
151+
.. _`Update client/agent`: https://github.com/deis/deis/issues/3811

0 commit comments

Comments
 (0)