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.

Sign up for GitHub

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

Jump to bottom

Camunda 8 Run authentication warning #4437

Merged
merged 7 commits into from
Oct 9, 2024
Merged

Camunda 8 Run authentication warning #4437

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9f1a66d
Fix link format and typo
mesellings Oct 9, 2024
a9bd8f7
Remove warning from k8s
mesellings Oct 9, 2024
bdd89f7
Edit cookie auth warning
mesellings Oct 9, 2024
ea10641
soften warning to caution
akeller Oct 9, 2024
388f040
Merge branch 'main' into c8run-link-fix
mesellings Oct 9, 2024
747612d
remove pinned 8.5 version from spring guide
conceptualshark Oct 9, 2024
7f6da51
remove warning, include as optional prereq
conceptualshark Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/getting-started-java-spring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too
</repositories>
```

2. Add the following dependency your `pom.xml` file, as a child of the `<dependencies>` element:
2. Add the following dependency to your `pom.xml` file, as a child of the `<dependencies>` element:

:::warning
akeller marked this conversation as resolved.
Show resolved Hide resolved
akeller marked this conversation as resolved.
Show resolved Hide resolved
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).

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/react-components/install-c8run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only).
:::

- OpenJDK 21+
Expand Down
4 changes: 2 additions & 2 deletions docs/self-managed/setup/deploy/local/c8run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only).
:::

- OpenJDK 21+
Expand Down
4 changes: 0 additions & 4 deletions docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@ Depending on your machine hardware and internet connection speed, the services m

## Connecting to Camunda 8 components

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

Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress.

:::note
Expand Down
4 changes: 0 additions & 4 deletions ...ed_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@ Depending on your machine hardware and internet connection speed, the services m

## Connecting to Camunda 8 components

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

Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress.

:::note
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-8.6/guides/getting-started-java-spring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too
</repositories>
```

2. Add the following dependency your `pom.xml` file, as a child of the `<dependencies>` element:
2. Add the following dependency to your `pom.xml` file, as a child of the `<dependencies>` element:

:::warning
akeller marked this conversation as resolved.
Show resolved Hide resolved
Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`.
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-8.6/guides/react-components/install-c8run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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?

Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only).
:::

- OpenJDK 21+
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only).
:::

- OpenJDK 21+
Expand Down
Loading