fleet/docs/1-Using-Fleet/7-Updating-Fleet.md
noahtalerman 715d7b44e2
Fix markdown link check CI action. (#169)
- Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor.
- Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns
- Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case)
- Fix all broken markdown links
2021-01-04 13:55:05 -08:00

74 lines
2.2 KiB
Markdown

# Updating Fleet
- [Overview](#overview)
- [Updating the Fleet binary](#updating-the-fleet-binary)
- [Raw binaries](#raw-binaries)
- [Docker container](#docker-container)
- [Running database migrations](#running-database-migrations)
## Overview
This guide explains how to update and run new versions of Fleet. For initial installation instructions, see [Installing Fleet](../2-Deployment/1-Installation.md).
There are two steps to perform a typical Fleet update. If any other steps are required, they will be noted in the release notes.
1. [Update the Fleet binary](#updating-the-fleet-binary)
2. [Run database migrations](#running-database-migrations)
As with any enterprise software update, it's a good idea to back up your MySQL data before updating Fleet.
## Updating the Fleet binary
Follow the binary update instructions corresponding to the original installation method used to install Fleet.
### Raw binaries
Download the latest raw Fleet binaries:
```
curl -O https://github.com/fleetdm/fleet/releases/latest/download/fleet.zip
```
Unzip the binaries for your platform:
```
# For a Darwin compatible binary
unzip fleet.zip 'darwin/*' -d fleet
./fleet/darwin/fleet --help
# For a Linux compatible binary
unzip fleet.zip 'linux/*' -d fleet
./fleet/linux/fleet --help
```
Replace the existing Fleet binary with the newly unzipped binary.
### Docker container
Pull the latest Fleet docker image:
```
docker pull fleetdm/fleet
```
## Running database migrations
Before running the updated server, perform necessary database migrations. It is always advised to back up the database before running migrations.
Database migrations in Fleet are intended to be run while the server is offline. Osquery is designed to be resilient to short downtime from the server, so no data will be lost from `osqueryd` clients in this process. Even on large Fleet installations, downtime during migrations is usually only seconds to minutes.
First, take the existing servers offline.
Run database migrations:
```
fleet prepare db
```
Note, if you would like to run this in a script, you can use the `--no-prompt` option to disable prompting before the migrations.
Start new Fleet server instances:
```
fleet serve
```