From d16efbdb95116bd7dae4fa00e7e03ecd648b9082 Mon Sep 17 00:00:00 2001 From: Bryce Bortree Date: Fri, 14 Jan 2022 12:38:04 -0800 Subject: [PATCH 1/2] Make changes to Docker Installation, including adding step by step instructions. --- docs/fides/docs/installation/docker.md | 35 +++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/fides/docs/installation/docker.md b/docs/fides/docs/installation/docker.md index 53ea25d3406..1b123580390 100644 --- a/docs/fides/docs/installation/docker.md +++ b/docs/fides/docs/installation/docker.md @@ -1,9 +1,36 @@ # Installation from Docker -For the ease of deployment in production, the community releases a production-ready reference container image. +Docker is a platform as a service that bundles software into containers, each of which contains everything the software needs to run, software, libraries, and configuration files. [Docker Hub](https://docs.docker.com/docker-hub/) makes it easy to manage container images. -The fidesctl community releases Docker Images which are reference images for fidesctl. Every time a new version of fidesctl is released, the images are available in the [ethyca/fidesctl DockerHub](https://hub.docker.com/r/ethyca/fidesctl/tags). There are also mid-release versions (dirty versions) that get uploaded to DockerHub on every commit to the main branch. +The fidesctl community releases a production-ready reference container image of fidesctl for the ease of deployment in production. -These reference images contain all of the extras and dependencies for running the Python application. However they do not contain the required Postgres database. +## Docker Hub Releases -Fidesctl requires multiple components to function as it is a multi-part application. You may therefore also be interested in launching fidesctl in the Docker Compose environment, see: [Running Fidesctl in Docker](../quickstart/docker.md). +The following is an overview of the fidesctl Docker Hub release process, including release cadence and what's included. + +**Release Cadences** + +Every time a new version of fidesctl is released, the images are available in the [ethyca/fidesctl DockerHub](https://hub.docker.com/r/ethyca/fidesctl/tags). + +There are also mid-release versions (dirty versions) that get uploaded to DockerHub on every commit to the main branch. Implementation is not finalized in mid-release versions. + +**What's Included** + +These reference images contain all of the extras and dependencies for running the Python application. However they do not contain the required Postgres database. Continue to [Setting up the database](./database.md). + +## Installation + +Install Docker and Docker Compose, then pull the latest container image from Docker Hub. + +1. Install `docker` locally (see [Docker Desktop](https://www.docker.com/products/docker-desktop) or your preferred installation). The minimum verified Docker version is `20.10.8` +2. If your `docker` installation did not include `docker-compose`, make sure to get at least version `1.29.0`. Installation instructions can be found in the [Docker Compose documentation](https://docs.docker.com/compose/install/). +3. Run `docker pull ethyca/fidesctl` to pull the latest fidesctl container image from Docker Hub. + +Congratulations! Fidesctl is now installed on your machine. +## Next Steps + +You're now ready to start enforcing privacy with Fidesctl! Below are suggestions for continuing your journey. + +- See [Setting up the database](./database.md) to set up the Postgresql for fidesctl. +- See [Running Fidesctl in Docker](../quickstart/docker.md) for more information on launching fidesctl in Docker Compose. Fidesctl requires multiple components to function as it is a multi-part application. +- See the [Tutorial](../tutorial/index.md) for a hands-on guide that solves real data privacy problems by setting up a Fidesctl data privacy workflow. \ No newline at end of file From cc2c0abcb115175dea7ac5d59be64aa8968f8f35 Mon Sep 17 00:00:00 2001 From: Bryce Bortree Date: Fri, 28 Jan 2022 09:41:01 -0800 Subject: [PATCH 2/2] Address PR feedback (move installation, docker-compose) --- docs/fides/docs/installation/docker.md | 20 +++++++++----------- docs/fides/docs/quickstart/docker.md | 3 +-- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/fides/docs/installation/docker.md b/docs/fides/docs/installation/docker.md index 1b123580390..9c3d6b17944 100644 --- a/docs/fides/docs/installation/docker.md +++ b/docs/fides/docs/installation/docker.md @@ -4,11 +4,19 @@ Docker is a platform as a service that bundles software into containers, each of The fidesctl community releases a production-ready reference container image of fidesctl for the ease of deployment in production. +## Installation + +1. Install `docker` locally (see [Docker Desktop](https://www.docker.com/products/docker-desktop) or your preferred installation). The minimum verified Docker version is `20.10.8`. +1. Confirm whether you have `docker-compose` using the command `docker-compose -v`. Make sure at least version `1.29.0` is installed. If your installation did not include `docker-compose`, installation instructions can be found in the [Docker Compose documentation](https://docs.docker.com/compose/install/). +1. Run `docker pull ethyca/fidesctl` to pull the latest fidesctl container image from Docker Hub. + +Congratulations! Fidesctl is now installed on your machine. + ## Docker Hub Releases The following is an overview of the fidesctl Docker Hub release process, including release cadence and what's included. -**Release Cadences** +**Release Cadence** Every time a new version of fidesctl is released, the images are available in the [ethyca/fidesctl DockerHub](https://hub.docker.com/r/ethyca/fidesctl/tags). @@ -17,16 +25,6 @@ There are also mid-release versions (dirty versions) that get uploaded to Docker **What's Included** These reference images contain all of the extras and dependencies for running the Python application. However they do not contain the required Postgres database. Continue to [Setting up the database](./database.md). - -## Installation - -Install Docker and Docker Compose, then pull the latest container image from Docker Hub. - -1. Install `docker` locally (see [Docker Desktop](https://www.docker.com/products/docker-desktop) or your preferred installation). The minimum verified Docker version is `20.10.8` -2. If your `docker` installation did not include `docker-compose`, make sure to get at least version `1.29.0`. Installation instructions can be found in the [Docker Compose documentation](https://docs.docker.com/compose/install/). -3. Run `docker pull ethyca/fidesctl` to pull the latest fidesctl container image from Docker Hub. - -Congratulations! Fidesctl is now installed on your machine. ## Next Steps You're now ready to start enforcing privacy with Fidesctl! Below are suggestions for continuing your journey. diff --git a/docs/fides/docs/quickstart/docker.md b/docs/fides/docs/quickstart/docker.md index 72d0b30434b..4826ec92d26 100644 --- a/docs/fides/docs/quickstart/docker.md +++ b/docs/fides/docs/quickstart/docker.md @@ -8,8 +8,7 @@ The recommended way to get Fidesctl running is via Docker. The following guide w Docker and Docker-Compose are the only requirements here. -1. Install `docker` locally (see [Docker Desktop](https://www.docker.com/products/docker-desktop) or your preferred installation). The minimum verified Docker version is `20.10.8` -1. If your `docker` installation did not include `docker-compose`, make sure to get at least version `1.29.0`. Installation instructions can be found [here](https://docs.docker.com/compose/install/). +Follow the installation instructions in the [Installation with Docker](../installation/docker.md#installation) guide. ## Docker Setup