Skip to content

Commit e4a8e92

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

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Commands:
2828
get-parameters
2929
put-parameters
3030
put-parameters-recursive
31+
manage-redis
3132
```
3233

3334
--endpoint-url specified the AWS API endpoint URL used. This should be used if using localstack or a similar aws mock service. You can also set the `AWS_ENDPOINT_URL` env var to enable this feature.

src/croudtech_python_aws_app_config/cli.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ def put_parameters_recursive(ctx, ssm_prefix, region, delete_first, values_path)
221221

222222
@cli.group()
223223
def manage_redis():
224+
"""Redis DB Allocation Management"""
224225
pass
225226

226227
@manage_redis.command()
@@ -236,6 +237,7 @@ def manage_redis():
236237
help="Include shared variables",
237238
)
238239
def show_db(ctx, environment_name, app_name, ssm_prefix, region, include_common):
240+
"""Show Allocated Redis Database for a specified application"""
239241
ssm_config = SsmConfig(
240242
environment_name=environment_name,
241243
app_name=app_name,
@@ -255,6 +257,7 @@ def show_db(ctx, environment_name, app_name, ssm_prefix, region, include_common)
255257
@click.option("--redis-host", help="The redis host", required=True)
256258
@click.option("--redis-port", help="The redis port", required=True, default=6379)
257259
def show_dbs(ctx, redis_host, redis_port):
260+
"""Show all allocated Redis databases"""
258261
redis_config_instance = RedisConfig(
259262
redis_host=redis_host,
260263
redis_port=redis_port,
@@ -271,6 +274,7 @@ def show_dbs(ctx, redis_host, redis_port):
271274
@click.option("--environment-name", help="The environment name", required=True)
272275
@click.option("--app-name", help="The application name", required=True)
273276
def allocate_db(ctx, redis_host, redis_port, environment_name, app_name):
277+
"""Allocate a Redis database for a specified application and environment"""
274278
redis_config_instance = RedisConfig(
275279
redis_host=redis_host,
276280
redis_port=redis_port,
@@ -290,6 +294,7 @@ def allocate_db(ctx, redis_host, redis_port, environment_name, app_name):
290294
@click.option("--environment-name", help="The environment name", required=True)
291295
@click.option("--app-name", help="The application name", required=True)
292296
def deallocate_db(ctx, redis_host, redis_port, environment_name, app_name):
297+
"""Remove Redis database allocation for the specified application and environment"""
293298
redis_config_instance = RedisConfig(
294299
redis_host=redis_host,
295300
redis_port=redis_port,

0 commit comments

Comments
 (0)