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

Add the REST config to the Ingress guides #4602

Merged
merged 11 commits into from
Jan 9, 2025
Merged

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Nov 13, 2024

Description

Relates to #4137
This addresses:

  • adding the Zeebe REST API configuration into the Ingress guides
  • adding a note that the ingress path should match the context path to the (pre-8.7 combined) Ingress guides
  • linking to the ingress config, clarify the context path is for Zeebe Gateway, and update organization of the context path section in the Zeebe REST API overview

I've added these changes to the available documentation, back through 8.5 for the Ingress docs - prior to that the formatting changes.

I've added these options into /next assuming that if the /v1 APIs remain available, it will still be useful, and if they're removed, we can address removing it at the same time as any other updates, but let me know if this isn't the right call.

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/).

Copy link
Contributor

github-actions bot commented Nov 13, 2024

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

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

  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.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.

@conceptualshark conceptualshark added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Nov 13, 2024
@conceptualshark conceptualshark changed the title Cg ingress rest Add the REST config to the Ingress guides Nov 13, 2024
pepopowitz
pepopowitz previously approved these changes Nov 18, 2024
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

makes sense to me, and clarifies. Thank you!

@conceptualshark conceptualshark marked this pull request as ready for review December 3, 2024 13:53
@conceptualshark
Copy link
Contributor Author

@jessesimpson36 Would you be able to double-check the update here? Thanks!

@akeller
Copy link
Member

akeller commented Dec 9, 2024

I've added these options into /next assuming that if the /v1 APIs remain available, it will still be useful, and if they're removed, we can address removing it at the same time as any other updates, but let me know if this isn't the right call.

I'd like to see a member of the Zeebe team pulled in to review this, given the Zeebe REST API is actively being removed. @conceptualshark can you reach out on #ask-zeebe?

jessesimpson36
jessesimpson36 previously approved these changes Dec 13, 2024
Copy link
Contributor

@jessesimpson36 jessesimpson36 left a comment

Choose a reason for hiding this comment

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

I read the content and verified the referenced options. This all looks good to me.

@conceptualshark
Copy link
Contributor Author

@akeller @jessesimpson36 With the zeebe REST API officially out of the docs for /next, I've updated this PR to remove the reference and remove the config from 8.7. Do you mind double-checking for a final review?

@akeller akeller added the deploy Stand up a temporary docs site with this PR label Jan 7, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs January 7, 2025 20:51 Destroyed
Comment on lines 31 to 33
:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each Component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that Component.
:::
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each Component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that Component.
:::
:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that component.
:::

Copy link
Member

Choose a reason for hiding this comment

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

Plus the other versions.

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

❓ For the C8 REST API (v2), do we need to add a similar change? Basically, adding info on this page with a similar link to the ingress setup instructions?

Otherwise, the changes look consistently applied across the relevant versions.

@github-actions github-actions bot temporarily deployed to camunda-docs January 8, 2025 21:13 Destroyed
@conceptualshark
Copy link
Contributor Author

@akeller I've updated the Camunda REST API page as described! I think this should be the last place where this info was located/unclear. 🤞

@conceptualshark conceptualshark merged commit 057faa6 into main Jan 9, 2025
8 of 9 checks passed
@conceptualshark conceptualshark deleted the cg-ingress-rest branch January 9, 2025 16:10
Copy link
Contributor

github-actions bot commented Jan 9, 2025

🧹 Preview environment for this PR has been torn down.

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

Successfully merging this pull request may close these issues.

4 participants