Skip to content
This repository was archived by the owner on Jan 30, 2020. It is now read-only.

Commit eaf2f7f

Browse files
authored
Merge pull request #1721 from jonboulle/master
*: add maintenance warnings
2 parents 10015a0 + 9635dbb commit eaf2f7f

File tree

5 files changed

+13
-104
lines changed

5 files changed

+13
-104
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1 @@
1-
# How to Contribute
2-
3-
CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
4-
GitHub pull requests. This document outlines some of the conventions on
5-
development workflow, commit message formatting, contact points and other
6-
resources to make it easier to get your contribution accepted.
7-
8-
# Certificate of Origin
9-
10-
By contributing to this project you agree to the Developer Certificate of
11-
Origin (DCO). This document was created by the Linux Kernel community and is a
12-
simple statement that you, as a contributor, have the legal right to make the
13-
contribution. See the [DCO](DCO) file for details.
14-
15-
# Email and Chat
16-
17-
The project currently uses the general CoreOS email list and IRC channel:
18-
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
19-
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
20-
21-
Please avoid emailing maintainers found in the MAINTAINERS file directly. They
22-
are very busy and read the mailing lists.
23-
24-
## Getting Started
25-
26-
- Fork the repository on GitHub
27-
- Read the [README](README.md) for build and test instructions
28-
- Play with the project, submit bugs, submit patches!
29-
30-
## Contribution Flow
31-
32-
This is a rough outline of what a contributor's workflow looks like:
33-
34-
- Create a topic branch from where you want to base your work (usually master).
35-
- Make commits of logical units.
36-
- Make sure your commit messages are in the proper format (see below).
37-
- Push your changes to a topic branch in your fork of the repository.
38-
- Make sure the tests pass, and add any new tests as appropriate.
39-
- Submit a pull request to the original repository.
40-
41-
Thanks for your contributions!
42-
43-
### Coding Style
44-
45-
CoreOS projects written in Go follow a set of style guidelines that we've documented
46-
[here](https://github.com/coreos/docs/tree/master/golang). Please follow them when
47-
working on your contributions.
48-
49-
### Format of the Commit Message
50-
51-
We follow a rough convention for commit messages that is designed to answer two
52-
questions: what changed and why. The subject line should feature the what and
53-
the body of the commit should describe the why.
54-
55-
```
56-
scripts: add the test-cluster command
57-
58-
this uses tmux to setup a test cluster that you can easily kill and
59-
start for debugging.
60-
61-
Fixes #38
62-
```
63-
64-
The format can be described more formally as follows:
65-
66-
```
67-
<subsystem>: <what changed>
68-
<BLANK LINE>
69-
<why this change was made>
70-
<BLANK LINE>
71-
<footer>
72-
```
73-
74-
The first line is the subject and should be no longer than 70 characters, the
75-
second line is always blank, and other lines should be wrapped at 80 characters.
76-
This allows the message to be easier to read on GitHub as well as in various
77-
git tools.
78-
79-
## Adding Tests
80-
81-
Ideally most functionalities should be covered by both unit tests and
82-
functional tests. This means, every time when you add a new functionality,
83-
you should also add unit tests, which is stored in *SRC_test.go*, as well as
84-
a [functional test](./functional/README.md), located under directory
85-
*./functional/*.
86-
87-
Note that when adding a unit test under a new directory, you need to make sure
88-
that the new directory must be added to *TESTABLE* in [./test](./test). Without
89-
doing that, CI cannot run the new unit tests at all. Even build errors cannot
90-
be automatically detected.
1+
fleet is no longer developed or maintained by CoreOS. If you are interested in the future of the project and taking over stewardship, please contact [email protected]

Documentation/achtung.png

3.36 KB
Loading

Documentation/fleet-scaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ CPU usage from parsing all D-Bus messages when interacting with systemd.
1717
- a) parsing the JSON-encoded representations (stored in etcd)
1818
- b) parsing the unit file itself (using go-systemd)
1919

20-
- The agent deals very poorly with inconsistent read/write latencies with etcdal
20+
- The agent deals very poorly with inconsistent read/write latencies with etcd
2121
(*what is the actual behaviour?*)
2222

2323
## Improvements

MAINTAINERS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
Jonathan Boulle <[email protected]> (@jonboulle)
2-
Nick Owens <[email protected]> (@mischief)
1+
fleet is no longer developed or maintained by CoreOS. If you are interested in the future of the project and taking over stewardship, please contact [email protected]

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## <img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"><img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"><img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"> Deprecation warning <img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"><img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"><img src="Documentation/achtung.png" alt="WARNING" width="30" height="30"><a name="deprecation-warning"></a>
2+
fleet is no longer developed or maintained by CoreOS. CoreOS instead recommends Kubernetes for all clustering needs.
3+
The project exists here for historical reference. If you are interested in the future of the project and taking over stewardship, please contact [email protected]
4+
15
# fleet - a distributed init system
26

37
[![Build Status](https://travis-ci.org/coreos/fleet.png?branch=master)](https://travis-ci.org/coreos/fleet)
@@ -9,12 +13,11 @@ fleet ties together [systemd][coreos-systemd] and [etcd][etcd] into a simple dis
913

1014
## Current status
1115

12-
fleet has seen production use for some time and is largely considered stable.
13-
However, there are known [scalability limitations][fleet-scaling] with its architecture.
14-
As such, it is not recommended to run fleet clusters larger than 100 nodes or with more than 1000 services.
15-
The fleet project is being maintained for bug fixes but the existing maintainers do not intend to add additional major features or significantly rework fleet to address these limitations.
16+
The fleet project is [no longer maintained](#deprecation-warning).
1617

17-
If you are a developer and wish to help maintain fleet and improve its scalability, please email the [maintainers][maintainers].
18+
As of v1.0.0, fleet has seen production use for some time and is largely considered stable.
19+
However, there are [various known and unresolved issues](https://github.com/coreos/fleet/issues), including [scalability limitations][fleet-scaling] with its architecture.
20+
As such, it is not recommended to run fleet clusters larger than 100 nodes or with more than 1000 services.
1821

1922
## Using fleet
2023

@@ -63,9 +66,9 @@ After you have machines configured (check `fleetctl list-machines`), get to work
6366

6467
### Building
6568

66-
fleet must be built with Go 1.4+ on a Linux machine. Simply run `./build` and then copy the binaries out of `bin/` directory onto each of your machines. The tests can similarly be run by simply invoking `./test`.
69+
fleet must be built with Go 1.5+ on a Linux machine. Simply run `./build` and then copy the binaries out of `bin/` directory onto each of your machines. The tests can similarly be run by simply invoking `./test`.
6770

68-
If you're on a machine without Go 1.4+ but you have Docker installed, run `./build-docker` to compile the binaries instead.
71+
If you're on a machine without Go 1.5+ but you have Docker installed, run `./build-docker` to compile the binaries instead.
6972

7073
## Project Details
7174

@@ -78,10 +81,6 @@ See the [API documentation][api-doc] for more information.
7881

7982
See the [releases tab][releases] for more information on each release.
8083

81-
### Contributing
82-
83-
See [CONTRIBUTING][contributing] for details on submitting patches and contacting developers via IRC and mailing lists.
84-
8584
### License
8685

8786
fleet is released under the Apache 2.0 license. See the [LICENSE][license] file for details.

0 commit comments

Comments
 (0)