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

feat(self-managed/console): describe tls config #4317

Merged
merged 7 commits into from
Dec 16, 2024

Conversation

urbanisierung
Copy link
Member

Description

Describes how to configure SSL for Console Self-Managed.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).
  • I included my new page in the sidebar file(s).
  • I added a redirect for a renamed or deleted page to the .htaccess file.

Copy link
Contributor

github-actions bot commented Sep 19, 2024

👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/self-managed/console-deployment/configuration/configuration.md
  • docs/self-managed/console-deployment/configuration/ssl.md
  • docs/self-managed/console-deployment/telemetry.md
  • docs/self-managed/operational-guides/application-configs.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@urbanisierung
Copy link
Member Author

@christinaausley This is a last-minute feature we've implemented for console self-managed (for the 8.6 release). It will be tested hopefully next week, but it would be great if you could have a quick look into the description. Thanks!

@christinaausley christinaausley added component:console Issues related with Console project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Sep 23, 2024
@christinaausley
Copy link
Contributor

@urbanisierung Happy to have a look -- also adding @conceptualshark for some SM-focused review.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

Two commits added here:

  1. I updated the URLs in the application-configs page. This should ensure they're all linking to the correct version of the docs.
  2. I organized some of this content into tables to make the steps/requirements a little clearer, but feel free to revert if you'd like me to update the content more as-is.

@j-lindner
Copy link

Hi, I might miss(understand) something, so apologies if question seems unnecessary:

Just to clarify: is it correct that Console application consists of both frontend and backend and that both, front- and backend are served on the same host? And therefore only 1 certificate and 1 set of SSL options is required (other than web modeler, where frontend (webapp) and backend (restapi) run separately)?

If yes, then this looks good to me 👍

(I didn't test it on a installation as of now though; could try to do that on friday if required, if there is a docker image available)

@urbanisierung
Copy link
Member Author

Just to clarify: is it correct that Console application consists of both frontend and backend and that both, front- and backend are served on the same host? And therefore only 1 certificate and 1 set of SSL options is required (other than web modeler, where frontend (webapp) and backend (restapi) run separately)?

@j-lindner exactly, that's how Console is working in SM. Frontend and Backend are served on the same host (basically the frontend app is served by the backend).

@akeller akeller added target:8.6 Issues included in the 8.6 release 8.6.0 October 2024 minor release labels Sep 27, 2024
@akeller
Copy link
Member

akeller commented Sep 27, 2024

@urbanisierung I added 8.6 labels to this, but please move it out of draft when you are ready.

@urbanisierung
Copy link
Member Author

@urbanisierung I added 8.6 labels to this, but please move it out of draft when you are ready.

@akeller Unfortunately we found a dependency in the helm charts that need to be implemented, so the feature won't gonna make it into the 8.6 release :(

@urbanisierung urbanisierung added target:8.7 Issues included in the 8.7 release and removed target:8.6 Issues included in the 8.6 release 8.6.0 October 2024 minor release labels Sep 30, 2024
@christinaausley
Copy link
Contributor

Hi @urbanisierung -- just checking in. Is this still slated for the 8.7 release as of now?

@urbanisierung
Copy link
Member Author

Hi @urbanisierung -- just checking in. Is this still slated for the 8.7 release as of now?

@christinaausley I hope so. One missing piece was implemented and we're waiting now for QA approval.

@urbanisierung urbanisierung marked this pull request as ready for review December 15, 2024 15:44
@urbanisierung urbanisierung enabled auto-merge (squash) December 15, 2024 15:44
@urbanisierung
Copy link
Member Author

@christinaausley We got green lights from QA. Can you please have a final look? Thanks!

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Dec 16, 2024
@urbanisierung urbanisierung merged commit 16e5145 into main Dec 16, 2024
9 of 10 checks passed
@urbanisierung urbanisierung deleted the pdp2357-self-managed-console-tls branch December 16, 2024 16:20
Copy link
Contributor

⚠️ Preview environment for commit 16e5145 is being deleted. This usually takes 2-3 minutes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:console Issues related with Console project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR target:8.7 Issues included in the 8.7 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

5 participants