Skip to content
This repository was archived by the owner on Jul 31, 2024. It is now read-only.

Update documentation#1764

Merged
jwhitlock merged 10 commits intomozilla:mainfrom
jwhitlock:update-docs
Jan 11, 2022
Merged

Update documentation#1764
jwhitlock merged 10 commits intomozilla:mainfrom
jwhitlock:update-docs

Conversation

@jwhitlock
Copy link
Contributor

@jwhitlock jwhitlock commented Jan 10, 2022

Update the deployment documentation:

  • Recreate the deployment diagram. I do not have access to the original diagram, so I recreated a much simpler version, omitting some of the details.
  • Refresh the text
  • Mention monitoring the replica lag and database disk usage
  • Update the instructions for current versions of the docker images
  • Include creating a test API key

Other changes:

  • Fix the auto-documenting environment configuration
  • Mention the innodb_log_file_size fix.

Fixes #1385.

This is not as detailed as the previous diagram, but doesn't include
services that are no longer used.
* Add that MariaDB 10.5 works
* Mention replica lag and the transaction log
* Update the rate control document with the innodb_log_file_size fix
... but remove some of the headers
* Style fixes
* Dependabot has been working since January 2021
* hashin is no longer recommended
@jwhitlock
Copy link
Contributor Author

User @HJJac wrote a script at #1642 (comment) that was very useful in updating these documents, and may be useful if you are trying to run Ichnaea via the Docker images. I decided against adding a script to the repo, because of the maintenance burden, and because local development is much easier with Docker and docker-compose.

@jwhitlock jwhitlock merged commit 8bcadb2 into mozilla:main Jan 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update deployment documentation

1 participant