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

consolidate manage cluster section #4202

Merged
merged 9 commits into from
Sep 20, 2024
Merged

Conversation

christinaausley
Copy link
Contributor

Description

Closes https://github.com/camunda/developer-experience/issues/241 by consolidating cluster actions into one page.

Notes

Will backport upon approval.

NOTE -- this PR is solely within the scope of https://github.com/camunda/developer-experience/issues/241, and does not address #3199.

This PR only condenses the cluster actions into one page as a starting point.

Tomorrow, I will launch a Miro board to discuss the content and sidebar layout in full that comes with #3199. CC @theburi

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

@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content component:console Issues related with Console project labels Aug 27, 2024
@christinaausley christinaausley requested review from akeller, theburi and a team August 27, 2024 19:26
@christinaausley christinaausley self-assigned this Aug 27, 2024
Copy link
Contributor

github-actions bot commented Aug 27, 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.5/.

  • docs/components/modeler/web-modeler/deploy-process-application.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.

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Aug 27, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 27, 2024 19:43 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs August 27, 2024 20:03 Destroyed
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.

Love merging this into one section - it looks great to me. I ran it through locally for any missing links/updates and it all seems good. 👍

@@ -40,3 +40,7 @@ Users without **Admin** roles can deploy only on `dev`, `test`, or `stage` clust
![cluster-healthy](./img/cluster-overview-new-cluster-healthy.png)

3. After the cluster is created, click on the cluster name to visit the cluster detail page.

:::note
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality will be limited, including the execution of BPMN timers and BPMN message catch events. To resume your cluster, navigate to the **Clusters** tab in Console, select the cluster name, and click **Resume cluster** within the **Cluster Details**.
Copy link
Contributor

Choose a reason for hiding this comment

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

When a cluster is paused, not all functionality will be limited, including the execution of BPMN timers and BPMN message catch events.

not sure what this means, times will continue to work? ;)

Development clusters will be paused if they go unused for two hours

i don't think this is how it works

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just migrated over the existing content for this PR -- is the content outdated then? Do you know the timeframe of when clusters are paused?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ultraschuppi Do you have any insight here I can update accordingly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the current state of autopausing:

  • clusters in trial organisations
  • tagged with dev
  • will be sent to sleep ~ 8h after they have been created / woken up the last time

we put trial-org clusters to sleep after a few days if we think they are not used (no process instances started), but i don't think this is even communicated

To resolve in a separate PR 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also

When a cluster is paused, not all functionality will be limited, including the execution of BPMN timers and BPMN message catch events.

not sure what this means, times will continue to work? ;)

I've updated this wording @ultraschuppi 👍

@christinaausley
Copy link
Contributor Author

I'm going to resolve the conflicts here and backport, with plans to open a PR regarding https://github.com/camunda/developer-experience/issues/390 this week.

@github-actions github-actions bot temporarily deployed to camunda-docs September 18, 2024 18:57 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 18, 2024 19:20 Destroyed
@christinaausley
Copy link
Contributor Author

This is ready for final review if you don't mind having a second look @conceptualshark 😄

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.

👍 Reviewed content, and double-checked the links. With the autopause updates going into a separate PR, this looks good to me!

@christinaausley christinaausley merged commit 72881cf into main Sep 20, 2024
7 checks passed
@christinaausley christinaausley deleted the consolidate-resume-cluster branch September 20, 2024 16:25
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

@mesellings
Copy link
Contributor

@christinaausley I see this work was merged (looks good btw!), unfortunately this puts the Note taken out as part of the Auto-pause work back into the docs, into the following two places:

Resume cluster:
image

At the bottom of the https://docs.camunda.io/docs/next/components/concepts/clusters/ page

How shall we handle this? Shall I create an issue and PR and take it out, or are you working on the cluster docs for any other issues atm?

@christinaausley
Copy link
Contributor Author

@mesellings Feel free to remove this as you see fit based on your ongoing work 👍 Apologies for the overlap.

@mesellings
Copy link
Contributor

Np - will do thanks! 👍

@mesellings
Copy link
Contributor

Issue created to address this: #4373

@mesellings mesellings mentioned this pull request Oct 1, 2024
9 tasks
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:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants