Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A number of CoreOS -> Flatcar updates #5

Merged
merged 5 commits into from
Sep 2, 2020
Merged

A number of CoreOS -> Flatcar updates #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a219de7
README: update name and pointer
Sep 2, 2020
0ecebb4
MAINTAINERS: remove, as it is outdated
Sep 2, 2020
c7e241a
NOTICE: include Kinvolk copyright, per the Apache v2 LICENSE
Sep 2, 2020
ffd6054
CONTRIBUTING: update links and CoreOS verbiage
Sep 2, 2020
90f7db7
README: update URL and host file path
Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to Contribute

CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
GitHub pull requests. This document outlines some of the conventions on
development workflow, commit message formatting, contact points and other
resources to make it easier to get your contribution accepted.
Expand All @@ -14,9 +14,9 @@ contribution. See the [DCO](DCO) file for details.

# Email and Chat

The project currently uses the general CoreOS email list and IRC channel:
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
The project currently uses the general Flatcar email list and IRC channel:
- Email: [flatcar-user](https://groups.google.com/g/flatcar-linux-user)
- IRC: #[flatcar](irc://irc.freenode.org:6667/#flatcar) IRC channel on freenode.org

Please avoid emailing maintainers found in the MAINTAINERS file directly. They
are very busy and read the mailing lists.
Expand Down
3 changes: 0 additions & 3 deletions MAINTAINERS
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Copyright 2020 Kinvolk GmbH

CoreOS Project
Copyright 2014 CoreOS, Inc

Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# locksmith

locksmith is a reboot manager for the CoreOS update engine which is able to use
locksmith is a reboot manager for the Flatcar update engine which is able to use
etcd to ensure that only a subset of a cluster of machines are rebooting
at any given time. `locksmithd` runs as a daemon on CoreOS machines and is
at any given time. `locksmithd` runs as a daemon on Flatcar hosts and is
responsible for controlling the reboot behaviour after updates.

## Configuration
Expand All @@ -17,21 +17,21 @@ engine has successfully applied an update:
These strategies will either be followed immediately after an update, or during
the next available [reboot window](#reboot-windows) if one has been configured.

These strategies can be configured via `/etc/coreos/update.conf` with a line that looks like:
These strategies can be configured via `/etc/flatcar/update.conf` with a line that looks like:

```
REBOOT_STRATEGY=reboot
```

The reboot strategy can also be configured through a [Container Linux Config](https://github.com/coreos/container-linux-config-transpiler/blob/master/doc/getting-started.md).
The reboot strategy can also be configured through a [Container Linux Config](https://github.com/flatcar-linux/container-linux-config-transpiler/blob/master/doc/getting-started.md).

The default strategy is to follow the `etcd-lock` strategy if etcd is running,
and to otherwise follow the `reboot` strategy.

## Usage

`locksmithctl` is a simple client that can be use to introspect and control the
lock used by locksmith. It is installed by default on CoreOS.
lock used by locksmith. It is installed by default on Flatcar Container Linux.

Run `locksmithctl -help` for a list of command-line options.

Expand Down Expand Up @@ -92,7 +92,7 @@ lock with other machines in the same group.

The purpose of groups is to allow faster updating of certain sets of machines
while maintaining availability of certain services. For example, in a cluster
of 5 CoreOS machines with all machines in the default group, if you have 2 load
of 5 Flatcar hosts with all machines in the default group, if you have 2 load
balancers and run `locksmithctl set-max 2`, then it is possible that both load
balancers would be rebooted at the same time, interrupting the service they
provide. However, if the load balancers are put into their own group named "lb",
Expand Down Expand Up @@ -182,8 +182,8 @@ For a client to take the lock, the document is swapped with this:

## Bugs

Please use the [CoreOS issue tracker][bugs] to report all bugs, issues, and feature requests.
Please use the [Flatcar issue tracker][bugs] to report all bugs, issues, and feature requests.

[semaphore]: http://en.wikipedia.org/wiki/Semaphore_(programming)
[cas]: https://coreos.com/etcd/docs/latest/api.html#atomic-compare-and-swap
[bugs]: https://github.com/coreos/bugs/issues/new?labels=component/locksmith
[cas]: https://etcd.io/docs/v3.3.12/learning/api/#transaction
[bugs]: https://github.com/flatcar-linux/flatcar/issues/new