Skip to content

docs: Cumulocity certificate authority documentation#3590

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
didier-wenzek:docs/integration-with-c8y-ca
May 13, 2025
Merged

docs: Cumulocity certificate authority documentation#3590
reubenmiller merged 2 commits intothin-edge:mainfrom
didier-wenzek:docs/integration-with-c8y-ca

Conversation

@didier-wenzek
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek commented Apr 30, 2025

Proposed changes

Cumulocity certificate authority documentation

  • Add certificate management reference page which goes into the technical details behind the c8y certificate-authority integration
  • Extend and update the Cumulocity Connect guide to include the Certificate Authority feature

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

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 30, 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 changed the title docs: Certificare management reference documentation docs: Certificate management reference documentation May 1, 2025
@reubenmiller reubenmiller force-pushed the docs/integration-with-c8y-ca branch from 5548cec to 1da5afe Compare May 12, 2025 14:12
@reubenmiller reubenmiller changed the title docs: Certificate management reference documentation docs: Cumulocity certificate authority documentation May 12, 2025
@reubenmiller reubenmiller added theme:c8y Theme: Cumulocity related topics theme:certificates Theme: Device certificate topics labels May 12, 2025
@reubenmiller reubenmiller marked this pull request as ready for review May 12, 2025 14:14
@reubenmiller reubenmiller self-requested a review as a code owner May 12, 2025 14:14
```

</UserContext>
There are a few different ways to get the device certificate to be trusted by Cumulocity, below lists a few common options.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We might say a word about a third option that is to get device certificate from a public CA and to upload the CA signing certificate to C8Y.

Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller May 12, 2025

Choose a reason for hiding this comment

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

Yes I was considering this, but couldn't get a reduced version which didn't go into the details of external CA, and how should the user then renew the certificate with them, as all of it really depends on the external CA.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Okay, so let say nothing in that section.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree that it would be worthwhile adding it, but it will take a bit longer to get a reasonable wording without getting too technical, so we can postpone that.

Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

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

Approved (though this was a joint PR between @didier-wenzek and @reubenmiller)

Copy link
Copy Markdown
Contributor Author

@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. Thanks @reubenmiller for the "operate" section.

@didier-wenzek didier-wenzek force-pushed the docs/integration-with-c8y-ca branch from 718cf50 to ee69e81 Compare May 13, 2025 08:30
@didier-wenzek didier-wenzek temporarily deployed to Test Pull Request May 13, 2025 08:30 — with GitHub Actions Inactive
@reubenmiller reubenmiller enabled auto-merge May 13, 2025 08:31
@didier-wenzek didier-wenzek force-pushed the docs/integration-with-c8y-ca branch from ee69e81 to 659a45a Compare May 13, 2025 08:31
didier-wenzek and others added 2 commits May 13, 2025 10:34
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@didier-wenzek didier-wenzek force-pushed the docs/integration-with-c8y-ca branch from 659a45a to 21b9e63 Compare May 13, 2025 08:34
@didier-wenzek didier-wenzek temporarily deployed to Test Pull Request May 13, 2025 08:34 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 13, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
631 0 3 631 100 1h54m30.961874999s

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label May 13, 2025
@reubenmiller reubenmiller added this pull request to the merge queue May 13, 2025
Merged via the queue into thin-edge:main with commit 3305ef7 May 13, 2025
34 checks passed
@didier-wenzek didier-wenzek deleted the docs/integration-with-c8y-ca branch May 13, 2025 11:29
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 theme:certificates Theme: Device certificate topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants