Skip to content

Commit

Permalink
Format validate_config() docstring to avoid a Sphinx warning
Browse files Browse the repository at this point in the history
This is the warning: "docstring of
fabrictestbed_extensions.fablib.fablib.FablibManager.validate_config:22:Explicit
markup ends without a blank line; unexpected unindent."
  • Loading branch information
sajith committed Jul 2, 2024
1 parent c7dd80c commit b169e6a
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions fabrictestbed_extensions/fablib/fablib.py
Original file line number Diff line number Diff line change
Expand Up @@ -676,27 +676,30 @@ def __init__(

def validate_config(self):
"""
Validate and create Fablib config - checks if all the required configuration exists for slice
provisioning to work successfully
Validate and create Fablib config - checks if all the required
configuration exists for slice provisioning to work
successfully
- Checks Credential Manager Host is configured properly
- Checks Credential Manager Host is configured properly
- Checks Orchestrator Host is configured properly
- Checks Orchestrator Host is configured properly
- Checks Core API Host is configured properly
- Checks Core API Host is configured properly
- Checks Bastion Host is configured properly
- Checks Bastion Host is configured properly
- Check Sliver keys exist; create sliver keys if they do not exist
- Check Sliver keys exist; create sliver keys if they do
not exist
- Check Bastion keys exist and are not expired; update/create bastion keys if expired or do not exist
- Check Bastion keys exist and are not expired;
update/create bastion keys if expired or do not exist
- Check Bastion Username is configured
- Check Bastion Username is configured
- Check Project Id is configured
- Check Project Id is configured
.. deprecated:: 1.6.5 Use `verify_and_configure()` instead.
.. deprecated:: 1.6.5
Use `verify_and_configure()` instead.
@raises Exception if the configuration is invalid
"""
warnings.warn(
Expand Down

0 comments on commit b169e6a

Please sign in to comment.