Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sparkfabrik/docker-ops-utils
This is a very small docker image with some useful operation utils (like rclone, mysql-client, postgresql-client, wait-for-it)
https://github.com/sparkfabrik/docker-ops-utils
Last synced: 23 days ago
JSON representation
This is a very small docker image with some useful operation utils (like rclone, mysql-client, postgresql-client, wait-for-it)
- Host: GitHub
- URL: https://github.com/sparkfabrik/docker-ops-utils
- Owner: sparkfabrik
- License: gpl-3.0
- Created: 2021-08-17T16:29:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T13:54:09.000Z (8 months ago)
- Last Synced: 2024-11-08T13:09:26.657Z (3 months ago)
- Language: Shell
- Size: 140 KB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ops-utils
This is a very small docker image with some useful operation utils (like rclone, mysql-client, postgresql-client, wait-for-it).
## AWS
AWS specific comands.
## Clean bucket (versioned)
```bash
docker run --rm ops-utils:latest aws clean-bucket
```
### Parameters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
| `--bucket` | `BUCKET` | Defines the bucket |
## Bucket operations
Bucket specific commands.
## Copy bucket
```bash
docker run --rm ops-utils:latest bucket copy-bucket
```
### Parameters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
`--provider` | `PROVIDER` | Defines the bucket provider (aws, gcs, minio) |
`--bucket-src-endpoint` | `BUCKET_SRC_ENDPOINT` | Defines the source bucket endpoint |
`--bucket-src` | `BUCKET_SRC` | Defines the source bucket |
`--file-src` | `FILE_SRC` | Defines the source file in the bucket (default: entire bucket) |
`--bucket-dst-endpoint` | `BUCKET_DST_ENDPOINT` | Defines the destination bucket endpoint |
`--bucket-dst` | `BUCKET_DST` | Defines the destination bucket |
`--file-dst` | `FILE_DST` | Defines the destination file in the bucket |
`--rclone-add-params` | `RCLONE_ADD_PARAMS` | Defines the additional parameters to be passed to rclone command |
`--timeout-bucket-src` | `TIMEOUT_BUCKET_SRC` | Defines the maximum waiting time for source bucket set up (default 10s) |
`--timeout-bucket-dst` | `TIMEOUT_BUCKET_DST` | Defines the maximum waiting time for destination bucket set up (default 10s) |
## MySQL
MySQL specific commands. The commands can manage plain SQL or GZIP compressed dump files.
## Import from bucket
```bash
docker run --rm ops-utils:latest mysql import-from-bucket
```
### Paramenters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
| `--db-host` | `DB_HOST` | Defines the database host |
| `--db-user` | `DB_USER` | Defines the database user |
| `--db-password` | `DB_PASSWORD` | Defines the database password |
| `--db-name` | `DB_NAME` | Defines the database name |
| `--db-port` | `DB_PORT` | Defines the database port [default: 3306] |
| `--provider` | `PROVIDER` | Defines the bucket provider (aws, gcs, minio) |
| `--bucket-endpoint` | `BUCKET_ENDPOINT` | Defines the bucket endpoint |
| `--bucket` | `BUCKET` | Defines the bucket |
| `--file` | `FILE` | Defines the file in the bucket (*.sql or *.sql.gz) |
| `--rclone-add-params` | `RCLONE_ADD_PARAMS` | Defines the additional parameters to be passed to rclone command |
| `--timeout-bucket` | `TIMEOUT_BUCKET` | Defines the maximum waiting time for bucket set up (default 10s) |
| `--timeout-mysql` | `TIMEOUT_MYSQL` | Defines the maximum waiting time for mysql service (default 30s) |
## Export to bucket
```bash
docker run --rm ops-utils:latest mysql export-to-bucket
```
### Paramenters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
| `--db-host` | `DB_HOST` | Defines the database host |
| `--db-user` | `DB_USER` | Defines the database user |
| `--db-password` | `DB_PASSWORD` | Defines the database password |
| `--db-name` | `DB_NAME` | Defines the database name |
| `--db-port` | `DB_PORT` | Defines the database port [default: 3306] |
| `--provider` | `PROVIDER` | Defines the bucket provider (aws, gcs, minio) |
| `--bucket-endpoint` | `BUCKET_ENDPOINT` | Defines the bucket endpoint |
| `--bucket` | `BUCKET` | Defines the bucket |
| `--file` | `FILE` | Defines the file in the bucket (*.sql or *.sql.gz) |
| `--rclone-add-params` | `RCLONE_ADD_PARAMS` | Defines the additional parameters to be passed to rclone command |
| `--mysqldump-add-params` | `MYSQLDUMP_ADD_PARAMS` | Defines the additional parameters to be passed to mysqldump command |
| `--timeout-bucket` | `TIMEOUT_BUCKET` | Defines the maximum waiting time for bucket set up (default 10s) |
| `--timeout-mysql` | `TIMEOUT_MYSQL` | Defines the maximum waiting time for mysql service (default 30s) |
## Export All databases to bucket
This command exports all databases to a bucket.
All databases are exported as a single file, using the name of the database as path (removing the `-db` suffix) and the `--file` parameter value as file name.
```bash
docker run --rm ops-utils:latest mysql export-all-to-bucket
```
### Paramenters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
| `--db-host` | `DB_HOST` | Defines the database host |
| `--db-user` | `DB_USER` | Defines the database user |
| `--db-password` | `DB_PASSWORD` | Defines the database password |
| `--db-name` | `DB_NAME` | Defines the database name |
| `--db-port` | `DB_PORT` | Defines the database port [default: 3306] |
| `--include-system` | `INCLUDE_SYSTEM` | Include Mysql system databases [default: false] |
| `--exclude` | `EXCLUDE_DATABASES` | Defines the databases to exclude |
| `--provider` | `PROVIDER` | Defines the bucket provider (aws, gcs, minio) |
| `--bucket-endpoint` | `BUCKET_ENDPOINT` | Defines the bucket endpoint |
| `--bucket` | `BUCKET` | Defines the bucket |
| `--file` | `FILE` | Defines the file in the bucket (*.sql or *.sql.gz) |
| `--rclone-add-params` | `RCLONE_ADD_PARAMS` | Defines the additional parameters to be passed to rclone command |
| `--mysqldump-add-params` | `MYSQLDUMP_ADD_PARAMS` | Defines the additional parameters to be passed to mysqldump command |
| `--timeout-bucket` | `TIMEOUT_BUCKET` | Defines the maximum waiting time for bucket set up (default 10s) |
| `--timeout-mysql` | `TIMEOUT_MYSQL` | Defines the maximum waiting time for mysql service (default 30s) |
## Drop DB tables
```bash
docker run --rm ops-utils:latest mysql drop-db-tables
```
### Paramenters
| Parameter | Environment Variable | Description |
| ----- | ----- | ----- |
| `--db-host` | `DB_HOST` | Defines the database host |
| `--db-user` | `DB_USER` | Defines the database user |
| `--db-password` | `DB_PASSWORD` | Defines the database password |
| `--db-name` | `DB_NAME` | Defines the database name |
| `--db-port` | `DB_PORT` | Defines the database port [default: 3306] |
| `--timeout-mysql` | `TIMEOUT_MYSQL` | Defines the maximum waiting time for mysql service (default 30s) |
## AWS Auth
In order to use the AWS S3 buckets you need to specify the following environment variables:
| Variable | Description |
| ----- | ----- |
| `AWS_ACCESS_KEY_ID` | AWS IAM access key ID |
| `AWS_SECRET_ACCESS_KEY` | AWS IAM secret access key |
| `AWS_DEFAULT_REGION` | AWS bucket region |
## GCS Auth
In order to use the Google Cloud Storage buckets you need to specify the following environment variable:
| Variable | Description |
| ----- | ----- |
| `GOOGLE_APPLICATION_CREDENTIALS` | Defines the file path of the service account file |
## Minio Auth
In order to use the Minio buckets you need to specify the following environment variables:
| Variable | Description |
| ----- | ----- |
| `BUCKET_ENDPOINT` | Defines the bucket endpoint |
| `AWS_ACCESS_KEY_ID` | Minio access key |
| `AWS_SECRET_ACCESS_KEY` | Minio secret key |