Skip to content
Permalink
Browse files

DOC: documentation for ctl upgrade-config

  • Loading branch information...
wagner-certat committed Jul 29, 2019
1 parent 7cbed35 commit bba26a2e8590e95ef98ca7ad07ed18994bee7a77
Showing with 6 additions and 5 deletions.
  1. +1 −1 NEWS.md
  2. +2 −1 docs/UPGRADING.md
  3. +3 −3 docs/intelmqctl.md
@@ -25,7 +25,7 @@ See the changelog for a full list of changes.
### Requirements

### Tools
intelmqctl has a new function `upgrade-conf` to upgrade the configuration from previous installations.
intelmqctl has a new function `upgrade-config` to upgrade the configuration from previous installations. It is recommended to call this function after every upgrade.

### Harmonization

@@ -70,13 +70,14 @@ Call the configuration upgrade function:
intelmqctl upgrade-conf
```

## Check the installation
## Upgrade configuration and check the installation

Go through [NEWS.md](../NEWS.md) and apply necessary adaptions to your setup.
If you have adapted IntelMQ's code, also read the [CHANGELOG.md](../CHANGELOG.md).

Check your installation and configuration to detect any problems:
```bash
intelmqctl upgrade-config
intelmqctl check
```

@@ -410,12 +410,12 @@ See the help page for more information.
This command will do various sanity checks on the installation and especially the configuration.

## Configuration upgrade
The `intelmqctl upgrade-conf` function upgrade, upgrade the configuration from previous versions to the current one.
It keeps track of previously installed versions and the result of all "upgrade functions" in the "state file", locate in the $var_state_path/state.json (e.g. /opt/intelmq/var/lib/state.json or /var/lib/intelmq/state.json).
The `intelmqctl upgrade-config` function upgrade, upgrade the configuration from previous versions to the current one.
It keeps track of previously installed versions and the result of all "upgrade functions" in the "state file", locate in the `$var_state_path/state.json` (`/opt/intelmq/var/lib/state.json` or `/var/lib/intelmq/state.json`).

This function has been introduced in version 2.0.1.

Make sure to have a backup of your configuration.
It makes backups itself for all changed files before every run. Backups are overridden if they already exists. So make sure to always have a backup of your configuration just in case.

## Exit code
In case of errors, unsuccessful operations, the exit code is higher than 0.

0 comments on commit bba26a2

Please sign in to comment.
You can’t perform that action at this time.