Skip to content

Commit d3fefdb

Browse files
author
Jim Robinson
committed
Update documentation
1 parent e4a8e92 commit d3fefdb

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,72 @@ Options:
141141
--help Show this message and exit.
142142
```
143143

144+
## manage-redis
145+
146+
Manage redis DB allocation
147+
148+
### Sub commands
149+
150+
#### allocate-db
151+
152+
```
153+
Usage: python -m croudtech_python_aws_app_config.cli manage-redis allocate-db
154+
[OPTIONS]
155+
156+
Allocate a Redis database for a specified application and environment
157+
158+
Options:
159+
--redis-host TEXT The redis host [required]
160+
--redis-port INTEGER The redis port [required]
161+
--environment-name TEXT The environment name [required]
162+
--app-name TEXT The application name [required]
163+
--help Show this message and exit.
164+
```
165+
166+
#### deallocate-db
167+
```
168+
Usage: python -m croudtech_python_aws_app_config.cli manage-redis deallocate-db
169+
[OPTIONS]
170+
171+
Remove Redis database allocation for the specified application and
172+
environment
173+
174+
Options:
175+
--redis-host TEXT The redis host [required]
176+
--redis-port INTEGER The redis port [required]
177+
--environment-name TEXT The environment name [required]
178+
--app-name TEXT The application name [required]
179+
--help Show this message and exit.
180+
```
181+
#### show-db
182+
```
183+
Usage: python -m croudtech_python_aws_app_config.cli manage-redis show-db
184+
[OPTIONS]
185+
186+
Show Allocated Redis Database for a specified application
187+
188+
Options:
189+
--environment-name TEXT The environment name [required]
190+
--app-name TEXT The app name [required]
191+
--ssm-prefix TEXT The ssm path prefix
192+
--region TEXT The AWS region
193+
--include-common / --ignore-common
194+
Include shared variables
195+
--help Show this message and exit.
196+
```
197+
#### show-dbs
198+
```
199+
Usage: python -m croudtech_python_aws_app_config.cli manage-redis show-dbs
200+
[OPTIONS]
201+
202+
Show all allocated Redis databases
203+
204+
Options:
205+
--redis-host TEXT The redis host [required]
206+
--redis-port INTEGER The redis port [required]
207+
--help Show this message and exit.
208+
```
209+
144210
## Nested file structure and environment variables
145211

146212
Nested values will have their keys flattened when being converted to environment variables. This allows for a simpler structure than just adding all your env vars separately.

0 commit comments

Comments
 (0)