Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.82 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.82 KB
Raw

updatectl - CoreOS update service CLI

updatectl lets you control and test the CoreOS update service. Subcommands let you manage users, groups, packages and write a very simple client that gets its state via environment variables.

About the Update Service

The update service is a tool that helps you manage large-scale rolling upgrades of software. The service consists of three main parts:

  1. A distributed web application that runs within docker containers.
  2. updatectl a CLI interface to the service
  3. Communication specification for your applications to report their current status and receive notifications of an available update.

Getting Started

Once you have gained access to your update service installation, check out the Getting Started guide that will walk you through configuration of your applications, groups and update settings.

Building the Client

Major releases for all platforms are listed under the Releases tab on this repository. If you'd like to build your own client:

  1. ./build
  2. The client is now built. Use it with ./updatectl <command>

Creating Releases

You can build a release of a specfic version by running scripts/build-release <git-tag-of-version>.

If you are a CoreOS developer, you may bump the version with scripts/bump-version <version>. You can do this and build a release at the same time with scripts/new-release.

Example: scripts/new-release 0.2.0+git.

Documentation

Using the Client - Read about all of the supported commands in updatectl

Example Upgrade Workflow - Walk through updating a set of containers running on CoreOS

Protocol - A technical document about the Omaha protocol