Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add general uri4files feature description #1194

Merged
merged 2 commits into from
Aug 22, 2023

Conversation

ejlee3
Copy link
Contributor

@ejlee3 ejlee3 commented Aug 22, 2023

Closes #1193

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README)

docs_src/microservices/general/index.md Outdated Show resolved Hide resolved
```

The authentication type and credentials are contained in the secret data specified by the Secret Name.
Only `httpheader` is currently supported.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please expand on the expected elements in the secret data. ie.

type=httpheader
headername=<name>
headercontents=<contents>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably also need to reference how to store the secrets.
Secure Mode:

Non-Secure Mode

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't about loading config, but about where the secrets for the URI are stored. Obviously we can't use InsecureSecrets when loading config from URI... :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created issues to address the SecretAPI comment and the InsecureSecrets comment
SecretAPI: #1196
InsecureSecrets Tab: #1197

Signed-off-by: Elizabeth J Lee <[email protected]>
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lenny-goodell lenny-goodell merged commit 637fd2b into edgexfoundry:main Aug 22, 2023
edgex-jenkins added a commit that referenced this pull request Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[URI4Files] Document URI for files in Crosscutting section
2 participants