| Name | croudtech-bootstrap JSON |
| Version |
0.1.56
JSON |
| download |
| home_page | None |
| Summary | Applicaton config via AWS S3 and AWS Secrets Manager |
| upload_time | 2024-10-18 10:09:27 |
| maintainer | None |
| docs_url | None |
| author | Jim Robinson |
| requires_python | <3.14,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python script to push and pull application config
This script is used to push and pull secrets, s3 config and ssm values for use in applications.
## Usage
### Pushing Config
```
Usage: croudtech-bootstrap put-config [OPTIONS] VALUES_PATH
Options:
--prefix TEXT The path prefix (Name prefix used when storing secrets and SSM values)
--region TEXT The AWS region (Defaults to the current region set using AWS_DEFAULT_REGION or AWS_REGION env vars)
--delete-first Delete the values in this path before pushing (useful for cleanup) This will remove any values with the current path prefix that aren't included in the files we're pushing.
--help Show this message and exit.
```
The put-config command requires the following file structure:
```
├── ENVIRONMENT_NAME_1
│ ├── common.yaml
│ ├── common.secret.yaml
│ ├── AppConfig1.yaml
│ ├── AppConfig1.secret.yaml
│ ├── AppConfig2.yaml
│ └── AppConfig2.secret.yaml
├── ENVIRONMENT_NAME_2
│ ├── common.yaml
│ ├── common.secret.yaml
│ ├── AppConfig1.yaml
│ ├── AppConfig1.secret.yaml
│ ├── AppConfig2.yaml
│ └── AppConfig2.secret.yaml
```
Running `python -m croudtech-bootstrap put-config CONFIG_FILES_PATH` will create config for AppConfig1 and AppConfig2 in both defined environments.
common.yaml and common.secret.yaml files contain shared config that will be used for all applications.
### Pulling config
```
Usage: croudtech-bootstrap get-config [OPTIONS]
Options:
--environment-name TEXT The environment name [required]
--app-name TEXT The app name [required]
--prefix TEXT The path prefix
--region TEXT The AWS region
--include-common / --ignore-common
Include shared variables
--output-format [json|yaml|environment|environment-export]
--parse-redis-param / --ignore-redis-param
Parse redis host and allocate a redis
database number. Requires network access to the redis instance
--help Show this message and exit.
```
Using the put-config example above we can pull the config as follows
```
croudtech-bootstrap get-config --environment-name ENVIRONMENT_NAME_1 --app-name AppConfig1 --output-format environment
```
## Installation
`pip install croudtech-bootstrap`
Raw data
{
"_id": null,
"home_page": null,
"name": "croudtech-bootstrap",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Jim Robinson",
"author_email": "jscrobinson@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6c/a5/03662bb308a2b87542d25f1204afb7271759cbae51c923a0f485f5cda4ff/croudtech_bootstrap-0.1.56.tar.gz",
"platform": null,
"description": "# Python script to push and pull application config\n\nThis script is used to push and pull secrets, s3 config and ssm values for use in applications.\n\n## Usage\n\n### Pushing Config\n\n```\nUsage: croudtech-bootstrap put-config [OPTIONS] VALUES_PATH\n\nOptions:\n --prefix TEXT The path prefix (Name prefix used when storing secrets and SSM values)\n --region TEXT The AWS region (Defaults to the current region set using AWS_DEFAULT_REGION or AWS_REGION env vars)\n --delete-first Delete the values in this path before pushing (useful for cleanup) This will remove any values with the current path prefix that aren't included in the files we're pushing.\n --help Show this message and exit.\n```\n\nThe put-config command requires the following file structure:\n\n```\n\u251c\u2500\u2500 ENVIRONMENT_NAME_1\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 common.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 common.secret.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig1.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig1.secret.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig2.yaml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 AppConfig2.secret.yaml\n\u251c\u2500\u2500 ENVIRONMENT_NAME_2\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 common.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 common.secret.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig1.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig1.secret.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 AppConfig2.yaml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 AppConfig2.secret.yaml\n```\n\nRunning `python -m croudtech-bootstrap put-config CONFIG_FILES_PATH` will create config for AppConfig1 and AppConfig2 in both defined environments.\n\ncommon.yaml and common.secret.yaml files contain shared config that will be used for all applications.\n\n### Pulling config\n\n```\nUsage: croudtech-bootstrap get-config [OPTIONS]\n\nOptions:\n --environment-name TEXT The environment name [required]\n --app-name TEXT The app name [required]\n --prefix TEXT The path prefix\n --region TEXT The AWS region\n --include-common / --ignore-common\n Include shared variables\n --output-format [json|yaml|environment|environment-export]\n --parse-redis-param / --ignore-redis-param\n Parse redis host and allocate a redis\n database number. Requires network access to the redis instance\n --help Show this message and exit.\n```\n\nUsing the put-config example above we can pull the config as follows\n\n```\ncroudtech-bootstrap get-config --environment-name ENVIRONMENT_NAME_1 --app-name AppConfig1 --output-format environment\n```\n\n## Installation\n\n`pip install croudtech-bootstrap`\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Applicaton config via AWS S3 and AWS Secrets Manager",
"version": "0.1.56",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0dd5f54ebf7d5268239bd02984b5e2ca6c65241b7df5997c56236024d644e59",
"md5": "94bec0022f4c3565034769be309aa501",
"sha256": "0bf3aa6f42f01c406874686570cde25deed2614597525592a5c7ef4e4a737fa1"
},
"downloads": -1,
"filename": "croudtech_bootstrap-0.1.56-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94bec0022f4c3565034769be309aa501",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 16004,
"upload_time": "2024-10-18T10:09:26",
"upload_time_iso_8601": "2024-10-18T10:09:26.875087Z",
"url": "https://files.pythonhosted.org/packages/d0/dd/5f54ebf7d5268239bd02984b5e2ca6c65241b7df5997c56236024d644e59/croudtech_bootstrap-0.1.56-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ca503662bb308a2b87542d25f1204afb7271759cbae51c923a0f485f5cda4ff",
"md5": "34fc33a94b5a85a2d4d84e851115605b",
"sha256": "468f191dcc52999ddd8e0d34518b61cdda761b97bc0f8d37b3fe51a3c82cfc04"
},
"downloads": -1,
"filename": "croudtech_bootstrap-0.1.56.tar.gz",
"has_sig": false,
"md5_digest": "34fc33a94b5a85a2d4d84e851115605b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 12103,
"upload_time": "2024-10-18T10:09:27",
"upload_time_iso_8601": "2024-10-18T10:09:27.990953Z",
"url": "https://files.pythonhosted.org/packages/6c/a5/03662bb308a2b87542d25f1204afb7271759cbae51c923a0f485f5cda4ff/croudtech_bootstrap-0.1.56.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 10:09:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "croudtech-bootstrap"
}
