Skip to content

Commit

Permalink
Add FAQ about migration to Other
Browse files Browse the repository at this point in the history
  • Loading branch information
quirogas committed Jul 21, 2023
1 parent f9f90e9 commit b832735
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
18 changes: 18 additions & 0 deletions docs/troubleshooting_and_faq/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,21 @@ If the pak file installs successfully but errors when creating an account (adapt
- Check that the Cloud Proxy supports containerized adapters. Containerized adapter
support is supported in VMware Aria Operations version 8.10.0 and later.

### Why am I seeing "Deleting connection-related keys from config.json" message?

As of version 1.0.0,
we've removed all connection-related keys from the [project config file](../references/project_config.md)
and migrated them to a new
[project connections file](../references/project_connections_config.md) (`connections.json`).
As part of this change, both `mp-test` and `mp-build` will migrate the connection-related
keys to the `connections.json` file when present in the `config.json` file
(The new `connections.json` file is also added to the `.gitignore`
to prevent sensitive information from being committed).
Moving all the connection-related information away from the `config.json` file allows users
to include their project configuration file in version control,
making using the same `container_repository` for the project easier.

???+ note

`mp-build` and `mp-init` do not remove `config.json` from `.gitignore`, so users who want to share the project's
`config.json` file must remove it manually.
8 changes: 4 additions & 4 deletions vmware_aria_operations_integration_sdk/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,13 @@ def extract(cls, path: str) -> Project:

if len(connections_data):
_config.seek(0)
logger.info(
f"deleting {CONNECTIONS_FILE_NAME} keys from {CONFIG_FILE_NAME}"
)
logger.info(f"Deleting connection-related keys from {CONFIG_FILE_NAME}")
json.dump(json_config, _config, indent=4, sort_keys=True)
_config.truncate()
logger.info(
f"To learn more about '{CONNECTIONS_FILE_NAME}' file visit TODO: ADD LINK HERE"
f"To learn more about this message, visit "
f"https://vmware.github.io/vmware-aria-operations-integration-sdk/troubleshooting_and_faq/other"
f"/#why-am-i-seeing-deleting-connection-related-keys-from-configjson-message"
)

if not os.path.isfile(connections_file):
Expand Down

0 comments on commit b832735

Please sign in to comment.