-
Notifications
You must be signed in to change notification settings - Fork 410
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c553b47
commit 9325bca
Showing
1 changed file
with
12 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,43 @@ | ||
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/fleetdm/fleet) | ||
|
||
# Fleet Deployment Guide | ||
# Fleet deployment guide | ||
|
||
This guide outlines the services configured in the Render blueprint for deploying the Fleet system, which includes a web service, a MySQL database, and a Redis server. | ||
|
||
## Services Overview | ||
## Services overview | ||
|
||
### 1. Fleet Web Service | ||
### 1. Fleet web service | ||
- **Type:** Web | ||
- **Runtime:** Image | ||
- **Image:** `fleetdm/fleet:latest` | ||
- **Description:** Main web service running the Fleet application, which is deployed using the latest Fleet Docker image. Configured to prepare the database before deployment. | ||
- **Health Check Path:** `/healthz` | ||
- **Environment Variables:** Connects to MySQL and Redis using service-bound environment variables. | ||
- **Health check path:** `/healthz` | ||
- **Environment variables:** Connects to MySQL and Redis using service-bound environment variables. | ||
|
||
### 2. Fleet MySQL Database | ||
- **Type:** Private Service (pserv) | ||
### 2. Fleet MySQL database | ||
- **Type:** Private service (pserv) | ||
- **Runtime:** Docker | ||
- **Repository:** [MySQL Example on Render](https://github.com/render-examples/mysql) | ||
- **Disk:** 10 GB mounted at `/var/lib/mysql` | ||
- **Description:** MySQL database used by the Fleet web service. Environment variables for database credentials are managed within the service and some are automatically generated. | ||
|
||
### 3. Fleet Redis Service | ||
- **Type:** Private Service (pserv) | ||
### 3. Fleet Redis service | ||
- **Type:** Private service (pserv) | ||
- **Runtime:** Image | ||
- **Repository:** [Redis Docker image](https://hub.docker.com/_/redis) | ||
- **Description:** Redis service for caching and other in-memory data storage needs of the Fleet web service. | ||
|
||
## Deployment Guide | ||
## Deployment guide | ||
|
||
### Prerequisites | ||
- You need an account on [Render](https://render.com). | ||
- Familiarity with Render's dashboard and deployment concepts. | ||
|
||
### Steps to Deploy | ||
### Steps to deploy | ||
|
||
Click the deploy on render button or import the blueprint from the Render service deployment dashboard. | ||
|
||
### Post-Deployment | ||
### Post-deployment | ||
|
||
Navigate to the generated URL and run through the initial setup. If you have a license key you can add it post-deploy as | ||
an environment variable `FLEET_LICENSE_KEY=value` in the Fleet service configuration. |