p20319658
/
monkey
forked from p34709852/monkey
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docs: Clarify "upgrade proceedure" for docker

This commit is contained in:
Mike Salvatore 2021-10-25 12:57:40 -04:00
parent d14e4dee31
commit c91d922277
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/setup/docker.md
View File

@ -33,6 +33,10 @@ The Infection Monkey Docker container works on Linux only. It is not compatible
``` ```
### 2. Start MongoDB ### 2. Start MongoDB
{{% notice info %}}
If you are upgrading the Infection Monkey to a new version, be sure to remove
any MongoDB containers or volumes associated with the previous version.
{{% /notice %}}
1. Start a MongoDB Docker container: 1. Start a MongoDB Docker container:
@ -62,6 +66,10 @@ been signed by a private certificate authority.
``` ```
### 3b. Start Monkey Island with user-provided certificate ### 3b. Start Monkey Island with user-provided certificate
{{% notice info %}}
If you are upgrading the Infection Monkey to a new version, be sure to remove
any volumes associated with the previous version.
{{% /notice %}}
1. Create a directory named `monkey_island_data`. If you already have it, 1. Create a directory named `monkey_island_data`. If you already have it,
**make sure it's empty**. This will serve as the location where Infection **make sure it's empty**. This will serve as the location where Infection
@ -132,13 +140,9 @@ After the Monkey Island docker container starts, you can access Monkey Island by
## Upgrading ## Upgrading
Currently, there's no "upgrade-in-place" option when a new version is released. Currently, there's no "upgrade-in-place" option when a new version is released.
To get an updated version, download it, stop the current container and run the To get an updated version, download it, stop and remove the current Monkey
installation commands again with the new file. Island and MongoDB containers and volumes, and run the installation commands
again with the new file.
If you've configured Monkey Island to use a docker volume to store runtime data,
make sure that it is empty before upgrading the Infection Monkey. Also make sure
that you use a clean volume for MongoDB, as database schemas may not be compatible
between different versions of the Infection Monkey.
If you'd like to keep your existing configuration, you can export it to a file If you'd like to keep your existing configuration, you can export it to a file
using the *Export config* button and then import it to the new Monkey Island. using the *Export config* button and then import it to the new Monkey Island.