From a90c6699602e4a6222399210b394a6865d2cf798 Mon Sep 17 00:00:00 2001 From: "Elijah C. Voigt" Date: Tue, 7 Feb 2017 14:56:02 -0800 Subject: [PATCH 1/2] Docs: Add fleet deprecation notice to docs. --- Documentation/api-v1-alpha.md | 1 - Documentation/api-v1.md | 2 ++ Documentation/architecture.md | 2 ++ Documentation/deployment-and-configuration.md | 2 ++ Documentation/examples/example-deployment.md | 2 ++ Documentation/examples/service-discovery.md | 2 ++ Documentation/rkt_guide.md | 2 ++ Documentation/unit-files-and-scheduling.md | 2 ++ Documentation/using-the-client.md | 2 ++ 9 files changed, 16 insertions(+), 1 deletion(-) delete mode 120000 Documentation/api-v1-alpha.md diff --git a/Documentation/api-v1-alpha.md b/Documentation/api-v1-alpha.md deleted file mode 120000 index 0db555288..000000000 --- a/Documentation/api-v1-alpha.md +++ /dev/null @@ -1 +0,0 @@ -api-v1.md \ No newline at end of file diff --git a/Documentation/api-v1.md b/Documentation/api-v1.md index fd1818983..30c959595 100644 --- a/Documentation/api-v1.md +++ b/Documentation/api-v1.md @@ -1,5 +1,7 @@ # fleet API v1 +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + The fleet API allows you to manage the state of the cluster using JSON over HTTP. ## Managing Units diff --git a/Documentation/architecture.md b/Documentation/architecture.md index def8c12d2..3c847f456 100644 --- a/Documentation/architecture.md +++ b/Documentation/architecture.md @@ -1,5 +1,7 @@ # Architecture +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + ## fleetd Every system in the fleet cluster runs a single `fleetd` daemon. Each daemon encapsulates two roles: the *engine* and the *agent*. An engine primarily makes scheduling decisions while an agent executes units. Both the engine and agent use the _reconciliation model_, periodically generating a snapshot of "current state" and "desired state" and doing the necessary work to mutate the former towards the latter. diff --git a/Documentation/deployment-and-configuration.md b/Documentation/deployment-and-configuration.md index 9e514642f..a255eb4ce 100644 --- a/Documentation/deployment-and-configuration.md +++ b/Documentation/deployment-and-configuration.md @@ -1,5 +1,7 @@ # Deploying fleet +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + Deploying `fleet` is as simple as dropping the `fleetd` binary on a machine with access to etcd and starting it. Deploying `fleet` on CoreOS is even simpler: just run `systemctl start fleet`. The built-in configuration assumes each of your hosts is serving an etcd endpoint at one of the default locations (http://127.0.0.1:2379 or http://127.0.0.1:4001). However, if your etcd cluster differs, you must make the corresponding configuration changes. diff --git a/Documentation/examples/example-deployment.md b/Documentation/examples/example-deployment.md index 430d72d8e..55924e50e 100644 --- a/Documentation/examples/example-deployment.md +++ b/Documentation/examples/example-deployment.md @@ -1,5 +1,7 @@ # Deploying a Service Using fleet +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + The following is an example of how one might deploy a load-balanced web service using fleet. This example deploys [subgun][subgun], a simple subscription tool for [mailgun][mailgun]. diff --git a/Documentation/examples/service-discovery.md b/Documentation/examples/service-discovery.md index fca29dca9..0acd62656 100644 --- a/Documentation/examples/service-discovery.md +++ b/Documentation/examples/service-discovery.md @@ -1,5 +1,7 @@ # Service Discovery +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + Since applications and networking environments vary widely between customer deployments, fleet does not provide a generalized, integrated solution for service discovery. However, there are a number of patterns available which can easily be implemented on top of fleet to provide automated and reliable service discovery. One such pattern, the _sidekick model_, is described below. ## Sidekick model diff --git a/Documentation/rkt_guide.md b/Documentation/rkt_guide.md index 2af248ee9..26d52e682 100644 --- a/Documentation/rkt_guide.md +++ b/Documentation/rkt_guide.md @@ -1,5 +1,7 @@ # Running fleetd under rkt +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + The following guide will show you how to run fleetd under rkt. ## Building fleet ACI diff --git a/Documentation/unit-files-and-scheduling.md b/Documentation/unit-files-and-scheduling.md index 302c06b66..e664060ae 100644 --- a/Documentation/unit-files-and-scheduling.md +++ b/Documentation/unit-files-and-scheduling.md @@ -1,5 +1,7 @@ # Unit Files +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + Unit files are the primary means of interacting with fleet. They define what you want to do, and how fleet should do it. fleet will schedule any valid service, socket, path or timer systemd unit to a machine in the cluster, taking into account a few special properties in the `[X-Fleet]` section. If you're new to using systemd unit files, check out the [Getting Started with systemd guide][systemd-guide]. diff --git a/Documentation/using-the-client.md b/Documentation/using-the-client.md index 9b01cb69f..9acb68216 100644 --- a/Documentation/using-the-client.md +++ b/Documentation/using-the-client.md @@ -1,5 +1,7 @@ # Using the Client +**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** + fleet provides a command-line tool called `fleetctl`. The commands provided by `fleetctl` are analogous to those of systemd's CLI, `systemctl`. From ae4684d1ef8f95f65f061078e28e79ccda999ef5 Mon Sep 17 00:00:00 2001 From: "Elijah C. Voigt" Date: Tue, 7 Feb 2017 15:33:58 -0800 Subject: [PATCH 2/2] docs: reword deprecation notice --- Documentation/api-v1.md | 2 +- Documentation/architecture.md | 2 +- Documentation/deployment-and-configuration.md | 2 +- Documentation/examples/example-deployment.md | 2 +- Documentation/examples/service-discovery.md | 2 +- Documentation/rkt_guide.md | 2 +- Documentation/unit-files-and-scheduling.md | 2 +- Documentation/using-the-client.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/api-v1.md b/Documentation/api-v1.md index 30c959595..d8730b467 100644 --- a/Documentation/api-v1.md +++ b/Documentation/api-v1.md @@ -1,6 +1,6 @@ # fleet API v1 -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** The fleet API allows you to manage the state of the cluster using JSON over HTTP. diff --git a/Documentation/architecture.md b/Documentation/architecture.md index 3c847f456..0d208029e 100644 --- a/Documentation/architecture.md +++ b/Documentation/architecture.md @@ -1,6 +1,6 @@ # Architecture -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** ## fleetd diff --git a/Documentation/deployment-and-configuration.md b/Documentation/deployment-and-configuration.md index a255eb4ce..6a508fc2e 100644 --- a/Documentation/deployment-and-configuration.md +++ b/Documentation/deployment-and-configuration.md @@ -1,6 +1,6 @@ # Deploying fleet -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** Deploying `fleet` is as simple as dropping the `fleetd` binary on a machine with access to etcd and starting it. diff --git a/Documentation/examples/example-deployment.md b/Documentation/examples/example-deployment.md index 55924e50e..2eb34b570 100644 --- a/Documentation/examples/example-deployment.md +++ b/Documentation/examples/example-deployment.md @@ -1,6 +1,6 @@ # Deploying a Service Using fleet -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** The following is an example of how one might deploy a load-balanced web service using fleet. This example deploys [subgun][subgun], a simple subscription tool for [mailgun][mailgun]. diff --git a/Documentation/examples/service-discovery.md b/Documentation/examples/service-discovery.md index 0acd62656..99c4720e0 100644 --- a/Documentation/examples/service-discovery.md +++ b/Documentation/examples/service-discovery.md @@ -1,6 +1,6 @@ # Service Discovery -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** Since applications and networking environments vary widely between customer deployments, fleet does not provide a generalized, integrated solution for service discovery. However, there are a number of patterns available which can easily be implemented on top of fleet to provide automated and reliable service discovery. One such pattern, the _sidekick model_, is described below. diff --git a/Documentation/rkt_guide.md b/Documentation/rkt_guide.md index 26d52e682..6ad431e30 100644 --- a/Documentation/rkt_guide.md +++ b/Documentation/rkt_guide.md @@ -1,6 +1,6 @@ # Running fleetd under rkt -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** The following guide will show you how to run fleetd under rkt. diff --git a/Documentation/unit-files-and-scheduling.md b/Documentation/unit-files-and-scheduling.md index e664060ae..faeb73bc6 100644 --- a/Documentation/unit-files-and-scheduling.md +++ b/Documentation/unit-files-and-scheduling.md @@ -1,6 +1,6 @@ # Unit Files -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** Unit files are the primary means of interacting with fleet. They define what you want to do, and how fleet should do it. diff --git a/Documentation/using-the-client.md b/Documentation/using-the-client.md index 9acb68216..84345f960 100644 --- a/Documentation/using-the-client.md +++ b/Documentation/using-the-client.md @@ -1,6 +1,6 @@ # Using the Client -**Fleet is no longer under active development, and receives only critical security fixes. After 2/1/2018, fleet will no longer be included in CoreOS Container Linux. New clusters should use [Kubernetes](CoreOS.com/kubernetes/docs/latest). Legacy fleet clusters should [run fleet in a container](CoreOS.com/fleet/docs/latest/launching-containers-fleet.html#running-fleet-with-ignition).** +**[fleet is no longer actively developed or maintained by CoreOS](https://coreos.com/blog/migrating-from-fleet-to-kubernetes.html). CoreOS instead recommends [Kubernetes](https://coreos.com/kubernetes/docs/latest/) for cluster orchestration.** fleet provides a command-line tool called `fleetctl`. The commands provided by `fleetctl` are analogous to those of systemd's CLI, `systemctl`.