Add updating kolide documentation (#1302)

Also add quickstart script information to install docs.

Closes #1300
This commit is contained in:
Zachary Wasserman 2017-02-24 11:11:46 -08:00 committed by GitHub
parent 0951cbfe1b
commit d0bc2e5a87
2 changed files with 91 additions and 0 deletions

View file

@ -9,6 +9,12 @@ The Kolide application is distributed as a single static binary. This binary ser
All of these are served via a built-in HTTP server, so there is no need for complex web server configurations. Once you've installed the `kolide` binary and it's infrastructure dependencies as illustrated below, refer to the [Configuring The Kolide Binary](./configuring-the-kolide-binary.md) documentation for information on how to use and configure the Kolide application.
## Kolide Quickstart
Kolide provides a [quickstart script](https://github.com/kolide/kolide-quickstart) that is the quickest way to get a demo Kolide instance up and running. For easiest install, see the instructions provided on your [Kolide license page](https://kolide.co/account/product-and-license#quick-start).
Note that the quickstart is not intended to be a production deployment. If you would like a production deployment, please choose one of the methods below.
## Installing the Kolide binary
Because everyone's infrastructure is different, there are a multiple options available for installing the Kolide binary.

View file

@ -0,0 +1,85 @@
Updating Kolide
=================
This guide explains how to update and run new versions of Kolide. For initial installation instructions, see [Installing Kolide](./installing-kolide.md).
There are two steps to perform a typical Kolide update. If any other steps are required, they will be noted in the release notes.
1. [Update the Kolide binary](#updating-the-kolide-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 Kolide.
## Updating the Kolide binary
Follow the binary update instructions corresponding to the original installation method used to install Kolide.
#### Kolide quickstart script
The quickstart script will automatically update and migrate Kolide when run. In the `kolide-quickstart` directory:
```
./demo.sh up
```
Step 2 is performed automatically, so no further action is necessary.
#### Docker container
Pull the latest Kolide docker image:
```
docker pull kolide/kolide
```
#### Debian Packages (Ubuntu, Debian)
Update Kolide through the Apt repository (the repository should have been added during initial install):
```
sudo apt-get update && sudo apt-get install kolide
```
#### Yum Packages (CentOS, RHEL, Amazon Linux)
Update Kolide through the Yum respository (the repository should have been added during initial install):
```
sudo yum update kolide
```
#### Raw binaries
Download the latest raw Kolide binaries:
```
curl -O https://dl.kolide.co/bin/kolide_latest.zip
```
Unzip the binaries for your platform:
```
# For a Darwin compatible binary
unzip kolide_latest.zip 'darwin/*' -d kolide
./kolide/darwin/kolide_darwin_amd64 --help
# For a Linux compatible binary
unzip kolide_latest.zip 'linux/*' -d kolide
./kolide/linux/kolide_linux_amd64 --help
```
Replace the existing Kolide binary with the newly unzipped binary.
## Running database migrations
Before running the updated server, perform necessary database migrations:
```
kolide prepare db
```
The updated Kolide server should now be ready to run:
```
kolide serve
```