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

fix: removing Separated ingress #4508

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

hamza-m-masood
Copy link
Contributor

@hamza-m-masood hamza-m-masood commented Oct 24, 2024

Description

closes: #4507
I am removing separated ingress from 8.7 docs

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 Oct 24, 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/operational-guides/troubleshooting/troubleshooting.md
  • docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md
  • docs/self-managed/setup/guides/ingress-setup.md
  • docs/self-managed/setup/install.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.

@hamza-m-masood hamza-m-masood requested a review from a team October 24, 2024 13:04
@hamza-m-masood hamza-m-masood added the 8.7.0-alpha1 November 2024 alpha release label Oct 24, 2024
Copy link
Member

@aabouzaid aabouzaid left a comment

Choose a reason for hiding this comment

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

Separate ingress is still mentioned in a couple of places.
Please search for separated ingress in the whole repo (but only for the next version).

@conceptualshark
Copy link
Contributor

@hamza-m-masood Would you like me to help with the 8.7 docs review for updating where we use separated Ingress? Happy to take that on as part of this PR.

@hamza-m-masood
Copy link
Contributor Author

@conceptualshark Yes please. Go ahead. Thanks for the help ❤️

@conceptualshark
Copy link
Contributor

@aabouzaid @hamza-m-masood I've gone ahead and found the other remaining instances of the separate ingress option in the 8.7 docs; this should be good to review again.

@conceptualshark conceptualshark requested a review from a team October 31, 2024 20:07
@conceptualshark conceptualshark self-assigned this Oct 31, 2024
@conceptualshark conceptualshark added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Oct 31, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 , just some rewording suggestions, particularly to change "e.g." to "for example" as we avoid using "e.g." in the docs.

@@ -394,7 +394,7 @@ console:
For more details, check [Console Helm values](https://artifacthub.io/packages/helm/camunda/camunda-platform#console-parameters).

:::note
Console Self-Managed requires the Identity component to authenticate. Camunda Helm Chart installs Identity by default. When logging in to Console when using port-forward, port-forward Keycloak service `kubectl port-forward svc/<RELEASE-NAME>-keycloak 18080:80` or configure Identity with Ingress as described in [combined and separated Ingress setup](/self-managed/setup/guides/ingress-setup.md).
Console Self-Managed requires the Identity component to authenticate. Camunda Helm Chart installs Identity by default. When logging in to Console when using port-forward, port-forward Keycloak service `kubectl port-forward svc/<RELEASE-NAME>-keycloak 18080:80` or configure Identity with Ingress as described in the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).
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
Console Self-Managed requires the Identity component to authenticate. Camunda Helm Chart installs Identity by default. When logging in to Console when using port-forward, port-forward Keycloak service `kubectl port-forward svc/<RELEASE-NAME>-keycloak 18080:80` or configure Identity with Ingress as described in the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).
Console Self-Managed requires the Identity component to authenticate. Camunda Helm Chart installs Identity by default. When logging in to Console when using port-forward, port-forward the Keycloak service `kubectl port-forward svc/<RELEASE-NAME>-keycloak 18080:80` or configure Identity with Ingress as described in the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).

2. **Separated setup:** In this setup, each component has its own Ingress/host e.g. `operate.camunda.example.com`, `optimize.camunda.example.com`, `zeebe.camunda.example.com`, etc.

There are no significant differences between the two setups. Rather, they both offer flexibility for different workflows.
Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed externally using Ingress with a **combined setup.** In this configuration, there are two Ingress objects: one Ingress object for all Camunda 8 web applications using a single domain. Each application has a sub-path e.g. `camunda.example.com/operate`, and `camunda.example.com/optimize` and another Ingress which uses gRPC protocol for Zeebe Gateway e.g. `zeebe.camunda.example.com`.
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
Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed externally using Ingress with a **combined setup.** In this configuration, there are two Ingress objects: one Ingress object for all Camunda 8 web applications using a single domain. Each application has a sub-path e.g. `camunda.example.com/operate`, and `camunda.example.com/optimize` and another Ingress which uses gRPC protocol for Zeebe Gateway e.g. `zeebe.camunda.example.com`.
Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed externally using Ingress with a **combined setup.** In this configuration, there are two Ingress objects: one Ingress object for all Camunda 8 web applications using a single domain. Each application has a sub-path, for example `camunda.example.com/operate`, and `camunda.example.com/optimize`, and another Ingress that uses gRPC protocol for Zeebe Gateway, for example `zeebe.camunda.example.com`.

Suggestions for removing "e.g"

---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::caution
The separated Ingress configuration has been deprecated in version 8.6. To ensure a smooth upgrade experience for new installations, we recommend using the **combined Ingress setup**.
The separated Ingress configuration has been removed in Camunda version 8.7. This guide refers to only the **combined Ingress setup**.
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
The separated Ingress configuration has been removed in Camunda version 8.7. This guide refers to only the **combined Ingress setup**.
The separated Ingress configuration has been removed in Camunda version 8.7. This guide covers a **combined Ingress setup**.

Rewording suggestion

Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed using Kubernetes Ingress.

In this example, we will use a combined Ingress configuration. For more information, refer to [combined and separated Ingress setup](/self-managed/setup/guides/ingress-setup.md).
Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed using Kubernetes Ingress. For more information, refer to the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).
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
Camunda 8 Self-Managed has multiple web applications and gRPC services. Both can be accessed using Kubernetes Ingress. For more information, refer to the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).
Camunda 8 Self-Managed has multiple web applications and gRPC services. These can be accessed using Kubernetes Ingress. For more information, refer to the [Ingress setup guide](/self-managed/setup/guides/ingress-setup.md).

Rewording suggestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha1 November 2024 alpha release component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Delete Separated ingress from 8.7 docs
4 participants