README.md in masking-1.1.2.pre.alpha vs README.md in masking-1.1.2

- old
+ new

@@ -4,11 +4,16 @@ [![Acceptance Test MySQL Status](https://github.com/kibitan/masking/workflows/Acceptance%20Test%20MySQL/badge.svg?branch=main)](https://github.com/kibitan/masking/actions?query=workflow%3A%22Acceptance+Test+MySQL%22+branch%3Amain) [![Acceptance Test MariaDB Status](https://github.com/kibitan/masking/workflows/Acceptance%20Test%20MariaDB/badge.svg?branch=main)](https://github.com/kibitan/masking/actions?query=workflow%3A%22Acceptance+Test+MariaDB%22+branch%3Amain) [![codecov](https://codecov.io/gh/kibitan/masking/branch/main/graph/badge.svg)](https://codecov.io/gh/kibitan/masking) [![Maintainability](https://api.codeclimate.com/v1/badges/290b3005ecc193a3d138/maintainability)](https://codeclimate.com/github/kibitan/masking/maintainability) +[![CodeScene Code Health](https://codescene.io/projects/38627/status-badges/code-health)](https://codescene.io/projects/38627) [![Gem Version](https://badge.fury.io/rb/masking.svg)](https://badge.fury.io/rb/masking) +<!-- +[![CodeScene System Mastery](https://codescene.io/projects/38627/status-badges/system-mastery)](https://codescene.io/projects/38627) +[![CodeScene Missed Goals](https://codescene.io/projects/38627/status-badges/missed-goals)](https://codescene.io/projects/38627) +--> The command line tool for anonymizing database records by parsing a SQL dump file and build a new SQL dump file with masking sensitive/credential data. ## Installation @@ -20,12 +25,12 @@ * Ruby 2.6/2.7/3.0/3.1/3.2 ## Supporting RDBMS -* MySQL: 5.5<sup>[1](#footnote1)</sup>, 5.6, 5.7, 8.0 -* MariaDB: 5.5, 10.0<sup>[2](#footnote2)</sup>, 10.1, 10.2, 10.3, 10.4, 10.5, 10.6, 10.7, 10.8, 10.9, 10.10, 10.11 +* MySQL: 5.7, 8.0, 8.1 +* MariaDB: 10.2<sup>[1](#footnote1)</sup>, 10.3<sup>[1](#footnote1)</sup>, 10.4, 10.5, 10.6, 10.7<sup>[1](#footnote1)</sup>, 10.8<sup>[1](#footnote1)</sup>, 10.9<sup>[1](#footnote1)</sup>, 10.10, 10.11, 11.0, 11.1 ## Usage 1. Setup configuration for anonymizing target tables/columns to `masking.yml` @@ -91,10 +96,16 @@ Usage: masking [options] -c, --config=FILE_PATH specify config file. default: masking.yml -v, --version version ``` +## presentation / demo + +[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/tnGLUhmHclI/0.jpg)](https://www.youtube.com/watch?v=tnGLUhmHclI) + +presentation: [Generate anonymised database with MasKING](https://speakerdeck.com/kibitan/generate-anonymised-database-with-masking-2023-dot-09-dot-21-euruko-unconference-talk) + ## Use case of anonymized (production) database * Analyzing production databases for BI, Machine Learning, troubleshooting with respecting GDPR * Stress test / Integration test * Performance optimization for slow query @@ -145,10 +156,12 @@ * `MYSQL_HOST`: database host(default: `localhost`) * `MYSQL_USER`: mysql user name(default: `mysqluser`} * `MYSQL_PASSWORD`: password for user(default: `password`) * `MYSQL_DBNAME`: database name(default: `mydb`) +NOTE: run with `TRACE=1` will show debug print. for the CI, `TRACE` environment variable on [setting field in the repository](https://github.com/kibitan/masking/settings/variables/actions/TRACE) + ##### with docker-compose ```bash docker-compose -f docker-compose.yml -f docker-compose/mysql80.yml run -e MYSQL_HOST=mysql80 app acceptance/run_test.sh ``` @@ -159,27 +172,25 @@ docker-compose/acceptance_test.sh mysql80 ``` The docker-compose file names for other database versions, specify that file. +* MySQL 8.1: [`docker-compose/mysql80.yml`](./docker-compose/mysql81.yml) * MySQL 8.0: [`docker-compose/mysql80.yml`](./docker-compose/mysql80.yml) * MySQL 5.7: [`docker-compose/mysql57.yml`](./docker-compose/mysql57.yml) -* MySQL 5.6: [`docker-compose/mysql56.yml`](./docker-compose/mysql56.yml) -* MySQL 5.5<sup>[1](#footnote1)</sup>: [`docker-compose/mysql55.yml`](./docker-compose/mysql55.yml) +* MariaDB 11.1: [`docker-compose/mariadb111.yml`](./docker-compose/mariadb111.yml) +* MariaDB 11.0: [`docker-compose/mariadb110.yml`](./docker-compose/mariadb110.yml) * MariaDB 10.11: [`docker-compose/mariadb1011.yml`](./docker-compose/mariadb1011.yml) * MariaDB 10.10: [`docker-compose/mariadb1010.yml`](./docker-compose/mariadb1010.yml) -* MariaDB 10.9: [`docker-compose/mariadb109.yml`](./docker-compose/mariadb109.yml) -* MariaDB 10.8: [`docker-compose/mariadb108.yml`](./docker-compose/mariadb108.yml) -* MariaDB 10.7: [`docker-compose/mariadb107.yml`](./docker-compose/mariadb107.yml) +* MariaDB 10.9<sup>[1](#footnote1): [`docker-compose/mariadb109.yml`](./docker-compose/mariadb109.yml) +* MariaDB 10.8<sup>[1](#footnote1): [`docker-compose/mariadb108.yml`](./docker-compose/mariadb108.yml) +* MariaDB 10.7<sup>[1](#footnote1): [`docker-compose/mariadb107.yml`](./docker-compose/mariadb107.yml) * MariaDB 10.6: [`docker-compose/mariadb106.yml`](./docker-compose/mariadb106.yml) * MariaDB 10.5: [`docker-compose/mariadb105.yml`](./docker-compose/mariadb105.yml) * MariaDB 10.4: [`docker-compose/mariadb104.yml`](./docker-compose/mariadb104.yml) -* MariaDB 10.3: [`docker-compose/mariadb103.yml`](./docker-compose/mariadb103.yml) -* MariaDB 10.2: [`docker-compose/mariadb102.yml`](./docker-compose/mariadb102.yml) -* MariaDB 10.1: [`docker-compose/mariadb101.yml`](./docker-compose/mariadb101.yml) -* MariaDB 10.0<sup>[2](#footnote2)</sup>: [`docker-compose/mariadb100.yml`](./docker-compose/mariadb100.yml) -* MariaDB 5.5: [`docker-compose/mariadb55.yml`](./docker-compose/mariadb55.yml) +* MariaDB 10.3<sup>[1](#footnote1): [`docker-compose/mariadb103.yml`](./docker-compose/mariadb103.yml) +* MariaDB 10.2<sup>[1](#footnote1)</sup>: [`docker-compose/mariadb102.yml`](./docker-compose/mariadb102.yml) #### [Markdown lint](https://github.com/markdownlint/markdownlint) ```bash bundle exec mdl *.md @@ -250,8 +261,6 @@ ## Code of Conduct Everyone interacting in the Masking project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kibitan/masking/blob/main/CODE_OF_CONDUCT.md). -<a name="footnote1">1</a>: <small> MySQL 5.5 is already not supported by [official](https://www.mysql.com/support/supportedplatforms/database.html)</small> - -<a name="footnote2">2</a>: <small> MariaDB 10.0 is already not supported by [official](https://mariadb.org/about/maintenance-policy/)</small> +<a name="footnote1">1</a>: <small> MariaDB 10.2, 10.3, 10.7, 10.8, 10.9 is already not supported by [official](https://mariadb.org/about/maintenance-policy/)</small>