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

docs: adding restAddress configuration for integration with Zeebe API #3639

Merged
merged 6 commits into from
Apr 23, 2024
Merged

docs: adding restAddress configuration for integration with Zeebe API #3639

merged 6 commits into from
Apr 23, 2024

Conversation

marcosgvieira
Copy link
Contributor

@marcosgvieira marcosgvieira commented Apr 9, 2024 •
edited by akeller

Description

I'm adding an extra property that can be used to configure communication between Tasklist and Zeebe Rest API.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 9, 2024 •
edited

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

houssain-barouni
houssain-barouni reviewed Apr 9, 2024
View reviewed changes
versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md Outdated
| camunda.tasklist.zeebe.gatewayAddress | Gateway address that points to Zeebe as hostname and port. | localhost:26500 |
| camunda.tasklist.zeebe.secure | Connection should be secure via Transport Layer Security (TLS). | false |
| camunda.tasklist.zeebe.certificatePath | Path to certificate used by Zeebe. This is necessary when the certificate isn't registered in the operating system. | - |
| camunda.tasklist.zeebe.restAddress | Path to Zeebe rest address. This is necessary to consume Zeebe API from Tasklist | http://localhost:8083 |
Copy link
Contributor

Choose a reason for hiding this comment

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

should we keep http://localhost:8083 default value in the future releases?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@houssain-barouni yes, we delivered 8.5 with this default, after we changed to improve e2e-tests, we need another PR for 8.5.1.

@akeller
Copy link
Member

akeller commented Apr 9, 2024

@marcosgvieira is this technically part of the 8.5 release? It should also be included in the /docs directory so it can be available in the 8.6 preview.

I'm also asking if we need to review and merge quickly so we can release this change ASAP.

@christinaausley christinaausley added component:tasklist Issues related with Tasklist project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Apr 9, 2024
@marcosgvieira
Copy link
Contributor Author

@marcosgvieira is this technically part of the 8.5 release? It should also be included in the /docs directory so it can be available in the 8.6 preview.

I'm also asking if we need to review and merge quickly so we can release this change ASAP.

@akeller I missed the commit of the file in the /docs, I just added it. Yes, it's part of 8.5, the customers initially would not touch this property but is never bad to have it documented.

@akeller akeller added the target:8.5 Issues included in the 8.5 release label Apr 9, 2024
marcosgvieira and others added 2 commits April 22, 2024 10:56
@marcosgvieira @akeller
Update versioned_docs/version-8.5/self-managed/tasklist-deployment/ta…
ac2d8ac 
…sklist-configuration.md

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>
@marcosgvieira @akeller
Update docs/self-managed/tasklist-deployment/tasklist-configuration.md
768c4d5 
Co-authored-by: Amara Graham <akeller@users.noreply.github.com>
@akeller
Copy link
Member

akeller commented Apr 23, 2024

I'll clean this up so we can get this merged 😎

@akeller akeller enabled auto-merge (squash) April 23, 2024 15:52
@akeller akeller merged commit 0d696a8 into main Apr 23, 2024
11 checks passed
@akeller akeller deleted the tasklist-add-restaddress branch April 23, 2024 16:13
theburi pushed a commit that referenced this pull request Jun 5, 2024
@marcosgvieira @akeller @theburi
docs: adding restAddress configuration for integration with Zeebe API (…
2d0ff08 
…#3639)

* docs: adding restAddress configuration for integration with Zeebe API

* docs: adding restAddress configuration for integration with Zeebe API

* Update versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>

* Update docs/self-managed/tasklist-deployment/tasklist-configuration.md

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>

* run format

---------

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>
Co-authored-by: Amara <amara.graham@camunda.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions left review comments

@akeller akeller akeller approved these changes

@houssain-barouni houssain-barouni houssain-barouni left review comments

@nathansandi nathansandi Awaiting requested review from nathansandi

Assignees

@marcosgvieira marcosgvieira

Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:tasklist Issues related with Tasklist project target:8.5 Issues included in the 8.5 release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@marcosgvieira @akeller @houssain-barouni @christinaausley