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

Camunda 8 Run authentication warning #4437

Merged
merged 7 commits into from
Oct 9, 2024
Merged

Camunda 8 Run authentication warning #4437

merged 7 commits into from
Oct 9, 2024

Conversation

mesellings
Copy link
Contributor

Description

This PR provides further temporary fixes to help resolve the Camunda 8 Run/REST API authentication issue.

  • Changed the warning to a caution, and reworded to remove limitation language and other components.
  • Additionally, fixed link format and typo

This does not address further changes required for this authentication issue, as detailed in the relevant Slack channel, namely:

To access the REST API (v1 or v2) you need to make use of the Cookie auth setup by the webapps and we need to document that too.

Once that documentation is complete, we should revisit these pages and change the caution link to point to the new auth documentation.

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

@mesellings mesellings added kind/bug Issues related with bugs in the documentation component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR labels Oct 9, 2024
@mesellings mesellings self-assigned this Oct 9, 2024
Copy link
Contributor

github-actions bot commented Oct 9, 2024

👋 🤖 🤔 Hello! 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/setup/deploy/local/local-kubernetes-cluster.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.

@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 09:31 Destroyed
megglos
megglos previously approved these changes Oct 9, 2024
Copy link
Contributor

@megglos megglos left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @mesellings for taking action here right away 🚀

@mesellings mesellings added the hold This issue is parked, do not merge. label Oct 9, 2024
@akeller akeller removed the hold This issue is parked, do not merge. label Oct 9, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 13:56 Destroyed
@jessesimpson36 jessesimpson36 self-requested a review October 9, 2024 14:13

:::warning
:::caution
Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`.
The Spring Zeebe SDK is currently pinned to version `8.5.0`.

^ If we'd like to remove the bug language, we can just note that it's currently set at 8.5 (and therefore required).

Copy link
Member

@romansmirnov romansmirnov left a comment

Choose a reason for hiding this comment

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

I shared my feedback on Slack already, so I disagree with having such a caution so prominent because it behaves as expected and the Camunda REST API is not really mentioned or used in the guides.


:::warning
:::caution
Copy link
Member

Choose a reason for hiding this comment

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

IMO, this caution/warning should be removed in favor of https://github.com/camunda/camunda-8-get-started-spring/pull/9/files - In a nutshell, the application.properties must be adjusted to make it work.


:::warning
:::caution
Copy link
Member

Choose a reason for hiding this comment

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

The same as above.

@@ -25,8 +25,8 @@ Camunda 8 Run includes the following:

## Prerequisites

:::warning
Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only).
:::caution
Copy link
Member

Choose a reason for hiding this comment

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

Being honest, to me this does not make sense. This installation guide does not reference the Camunda REST API at all. The page still focuses on the old architecture by talking about Zeebe configuration, gRPC endpoints, etc.

@@ -1,7 +1,7 @@
### Prerequisites

:::warning
Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only).
:::caution
Copy link
Member

Choose a reason for hiding this comment

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

I think the Camunda REST API is not referenced or promoted in the guides, so why is this "caution" necessary?

@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 14:28 Destroyed
@akeller
Copy link
Member

akeller commented Oct 9, 2024

I shared my feedback on Slack already, so I disagree with having such a caution so prominent because it behaves as expected and the Camunda REST API is not really mentioned or used in the guides.

Thanks @romansmirnov. We also have instructions to work with C8Run that may be for non-getting started users. We've softened this quite a bit and removed the admonition so people are proactively informed.

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.

Based on the conversations in the Zoom, this looks like it satisfies feedback in a way that centers the developer experience without being too shouty.

@akeller akeller enabled auto-merge (squash) October 9, 2024 14:54
@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 15:12 Destroyed
@akeller akeller merged commit 5e4aa06 into main Oct 9, 2024
7 checks passed
@akeller akeller deleted the c8run-link-fix branch October 9, 2024 15:14
Copy link
Contributor

github-actions bot commented Oct 9, 2024

🧹 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:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR kind/bug Issues related with bugs in the documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

5 participants