Skip to content

docs: set ownership of Cumulocity basic auth credentials file#3797

Merged
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-c8y-basic-auth-ownership-note
Sep 29, 2025
Merged

docs: set ownership of Cumulocity basic auth credentials file#3797
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-c8y-basic-auth-ownership-note

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Extend the Cumulocity basic auth instructions to ensure the user creates a file which is readable by the tedge user (which the tedge-mapper-c8y service is run under).

The credentials.toml file is also encourages to be read-only for the owner since it contains sensitive information (similar to a certificate).

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

…ml file

Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added the theme:c8y Theme: Cumulocity related topics label Sep 26, 2025
@reubenmiller reubenmiller changed the title docs: add instructions to set ownership of Cumulocity basic auth credentials file docs: set ownership of Cumulocity basic auth credentials file Sep 26, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Sep 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Sep 29, 2025
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
700 0 3 700 100 2h11m30.902915s

@reubenmiller reubenmiller added this pull request to the merge queue Sep 29, 2025
Merged via the queue into thin-edge:main with commit ad5870a Sep 29, 2025
34 checks passed
@reubenmiller reubenmiller deleted the docs-c8y-basic-auth-ownership-note branch September 29, 2025 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:c8y Theme: Cumulocity related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants