X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/07188998130b931caf6d76bad0e6325377dac4cb..d6d65b2e627e46df6bdaef4a6135e598c64038ae:/README.md diff --git a/README.md b/README.md index 868477fb9..6b6304834 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,33 @@ # OpenStreetMap chef cookbooks -[![Build Status](https://travis-ci.org/openstreetmap/chef.svg?branch=master)](https://travis-ci.org/openstreetmap/chef) +[![Cookstyle](https://github.com/openstreetmap/chef/workflows/Cookstyle/badge.svg?branch=master&event=push)](https://github.com/openstreetmap/chef/actions?query=workflow%3ACookstyle%20branch%3Amaster%20event%3Apush) +[![Test Kitchen](https://github.com/openstreetmap/chef/workflows/Test%20Kitchen/badge.svg?branch=master&event=push)](https://github.com/openstreetmap/chef/actions?query=workflow%3A%22Test+Kitchen%22%20branch%3Amaster%20event%3Apush) This repository manages the configuration of all the servers run by the OpenStreetMap Foundation's Operations Working Group. We use -[Chef](https://www.chef.io/) to automated the configuration of all of our +[Chef](https://www.chef.io/) to automate the configuration of all of our servers. +[OSMF Operations Working Group](https://operations.osmfoundation.org/) + # Roles We make extensive use of roles to configure the servers. In general we have: -## Server-specific roles (e.g. [katla.rb](roles/katla.rb)) +## Server-specific roles (e.g., [faffy.rb](roles/faffy.rb)) These deal with particular setup or quirks of a server, such as its IP address. They also include roles representing the service they are performing, and the location they are in and any particular hardware they have that needs configuration. -All our servers are [named after dragons](http://wiki.openstreetmap.org/wiki/Servers/Name_Ideas). +All our servers are [named after dragons](https://wiki.openstreetmap.org/wiki/Servers/Name_Ideas). -## Hardware-specific roles (e.g. [tyan-s7010.rb](roles/tyan-s7010.rb)) +## Hardware-specific roles (e.g., [hp-g9.rb](roles/hp-g9.rb)) Covers anything specific to a certain piece of hardware, like a motherboard, that could apply to multiple machines. -## Location-specific roles (e.g. [ic.rb](roles/ic.rb)) +## Location-specific roles (e.g., [equinix-dub.rb](roles/equinix-dub.rb)) These form a hierarchy of datacentres, organisations, and countries where our servers are located. -## Service-specific roles (e.g. [web-frontend](roles/web-frontend.rb)) +## Service-specific roles (e.g., [web-frontend](roles/web-frontend.rb)) These cover the services that the server is running, and will include the recipes required for that service along with any specific configurations and other cascading roles. @@ -34,9 +37,10 @@ We use the 'Organization Repository' approach, where we have all our cookbooks i # Contributing -Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details. +Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details. The guide also includes details on how to run the tests locally. # Contact Us * Twitter: [@OSM_Tech](https://twitter.com/OSM_Tech) -* IRC: [#OSM-Dev on irc.oftc.net](http://irc.openstreetmap.org/) +* Mastodon / Fediverse: [@OSM_Tech](https://en.osm.town/@osm_tech) +* IRC: [#OSM-Dev on irc.oftc.net](https://irc.openstreetmap.org/)