diff --git a/docs/components/concepts/backups.md b/docs/components/concepts/backups.md index df854ec93d..2dd8a7d263 100644 --- a/docs/components/concepts/backups.md +++ b/docs/components/concepts/backups.md @@ -35,7 +35,7 @@ Manual backups refer to the user-initiated process of creating a consistent snap ### Retention and rate limits -To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every five hours. +To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every hour. However, users can delete an existing backup to create a new one before the rate limit period ends. The system retains the three most recent completed backups per cluster. Failed backup attempts do not count towards the retention count. When a new backup is successful and the retention count is reached, the oldest backup is automatically deleted. diff --git a/docs/components/modeler/web-modeler/camunda-marketplace.md b/docs/components/modeler/web-modeler/camunda-marketplace.md index c5d360f4a4..ed857fb8e0 100644 --- a/docs/components/modeler/web-modeler/camunda-marketplace.md +++ b/docs/components/modeler/web-modeler/camunda-marketplace.md @@ -6,7 +6,7 @@ description: "Visit the Camunda Marketplace to browse available resources, and i Discover the **Camunda Marketplace**, your go-to destination for leveraging various contributions from the Camunda community, trusted partners, and the Camunda team. -Follow our intuitive guides to explore and harness Connectors and process blueprints using Web Modeler. If you prefer to utilize these resources within Desktop Modeler, download them directly from the [Camunda Marketplace website](https://marketplace.camunda.com). +Follow our intuitive guides to explore and harness Connectors and blueprints using Web Modeler. If you prefer to utilize these resources within Desktop Modeler, download them directly from the [Camunda Marketplace website](https://marketplace.camunda.com). If you are a **[Web Modeler Self-Managed](/self-managed/modeler/web-modeler/installation.md)** user, be aware that your organization may restrict access to marketplace resources. If you are unsure about your organization's access, contact your organization's owner for clarification. @@ -51,16 +51,16 @@ For the out-of-the-box Connectors provided by Camunda, the Connectors Bundle pro This means a developer created a template and reused one of the Camunda Connector runtimes. Only for these templates is direct **Download to project** available. ::: -## Browse Marketplace process blueprints +## Browse Marketplace blueprints 1. Log in to your Camunda account and navigate to Web Modeler by clicking the Camunda components icon in the top left corner of your console, and then select Modeler. 2. Select an existing project or create a new one within the projects tab. -3. If you initiate a project with a pre-defined process blueprint, navigate to the Marketplace modal by clicking on **Browse process blueprints**. If you wish to incorporate it into an existing project, open the **Create new** dropdown and select **Browse process blueprints**. - ![Browse-process-blueprints-ctas](./img/browse-process-blueprints-ctas.png) +3. If you initiate a project with a pre-defined blueprint, navigate to the Marketplace modal by clicking on **Browse blueprints**. If you wish to incorporate it into an existing project, open the **Create new** dropdown and select **Browse blueprints**. + ![Browse-blueprints-ctas](./img/browse-blueprints-ctas.png) 4. Within the modal, you'll discover a variety of applications submitted by Camunda, partners, or community members to the **Camunda Marketplace**. Utilize the sidebar to filter applications by use case, or leverage the sub-navigation to search and filter by industry, creator, or supported Camunda version. ![Marketplace-modal-blueprints](./img/marketplace-modal-blueprints.png) -5. Once you've found the desired process blueprint, click **Use blueprint** to open it in Web Modeler and start your work. The process blueprint will be automatically saved within the project you initiated. -6. If you can't find the right process blueprint, you can suggest ideas in our [Idea Portal](https://marketplace.camunda.com/en-US/pages/connectorsIdeaPortal) or contribute your own process to the [Camunda Marketplace](https://marketplace.camunda.com/en-US/pages/submissionMenu). +5. Once you've found the desired blueprint, click **Use blueprint** to open it in Web Modeler and start your work. The blueprint will be automatically saved within the project you initiated. +6. If you can't find the right blueprint, you can suggest ideas in our [Idea Portal](https://marketplace.camunda.com/en-US/pages/connectorsIdeaPortal) or contribute your own process to the [Camunda Marketplace](https://marketplace.camunda.com/en-US/pages/submissionMenu). ## Additional resources diff --git a/docs/components/modeler/web-modeler/img/browse-blueprints-ctas.png b/docs/components/modeler/web-modeler/img/browse-blueprints-ctas.png new file mode 100644 index 0000000000..8d32b6c257 Binary files /dev/null and b/docs/components/modeler/web-modeler/img/browse-blueprints-ctas.png differ diff --git a/docs/components/modeler/web-modeler/img/browse-process-blueprints-ctas.png b/docs/components/modeler/web-modeler/img/browse-process-blueprints-ctas.png deleted file mode 100644 index 5db17f74b2..0000000000 Binary files a/docs/components/modeler/web-modeler/img/browse-process-blueprints-ctas.png and /dev/null differ diff --git a/docs/components/modeler/web-modeler/img/marketplace-modal-blueprints.png b/docs/components/modeler/web-modeler/img/marketplace-modal-blueprints.png index 20446a5b01..5a81c52b6b 100644 Binary files a/docs/components/modeler/web-modeler/img/marketplace-modal-blueprints.png and b/docs/components/modeler/web-modeler/img/marketplace-modal-blueprints.png differ diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index f4ad27e549..753e0a86ef 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -81,7 +81,7 @@ To deploy your process, take the following steps: 3. Change the **Cluster endpoint** to `http://localhost:26500/`, with no authentication. 4. Click **Deploy**. -When you open Operate at http://localhost:8081/, you should now note the process deployed to your local Self-Managed setup. +When you open Operate at http://localhost:8080/operate/, you should now note the process deployed to your local Self-Managed setup. ## Step 5: Run your process from Modeler @@ -119,7 +119,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too ``` -2. Add the following dependency to your `pom.xml` file: +2. Add the following dependency your `pom.xml` file, as a child of the `` element: ``` @@ -181,7 +181,24 @@ In your terminal, run `mvn spring-boot:run`, where you should see the `charging To start a process instance programmatically, take the following steps: -1. In `ProcessPaymentsApplication.java`, convert the application to a `CommandLineRunner`, by adding `implements CommandLineRunner` to the `ProcessPaymentsApplication` class declaration. Instantiate a static `Logger` variable, and an instance variable named `zeebeClient` with the `@Autowired` annotation. +1. In `ProcessPaymentsApplication.java`, add the following dependencies after the package definition: + +```java +package io.camunda.demo.process_payments; + +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +import io.camunda.zeebe.client.ZeebeClient; +import io.camunda.zeebe.spring.client.annotation.Deployment; +``` + +2. Convert the application to a `CommandLineRunner`, by adding `implements CommandLineRunner` to the `ProcessPaymentsApplication` class declaration. Instantiate a static `Logger` variable, and an instance variable named `zeebeClient` with the `@Autowired` annotation. ```java @SpringBootApplication @@ -199,7 +216,7 @@ public class ProcessPaymentsApplication implements CommandLineRunner { } ``` -2. Implement an overriding `run` method in `ProcessPaymentsApplication`. When the application runs, it will create a new `process-payments` process instance, of the latest version, with specified variables, and send it to our local Self-Managed instance: +3. Implement an overriding `run` method in `ProcessPaymentsApplication`. When the application runs, it will create a new `process-payments` process instance, of the latest version, with specified variables, and send it to our local Self-Managed instance: ```java @Override diff --git a/docs/guides/react-components/install-plain-java.md b/docs/guides/react-components/install-plain-java.md index db97e716b8..a1dfab52e2 100644 --- a/docs/guides/react-components/install-plain-java.md +++ b/docs/guides/react-components/install-plain-java.md @@ -22,7 +22,7 @@ Confirm Elasticsearch is running by visiting `http://localhost:9200` in a browse ### Download and configure Camunda -1. Download the [latest release artifact](https://github.com/camunda/camunda/releases) in the **Assets** section of the release page, starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2). +1. Download and extract the [latest `camunda-zeebe-` release artifact](https://github.com/camunda/camunda/releases) in the **Assets** section of the release page, starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2). 2. Navigate to the directory where you installed Camunda, and open `/config/application.yaml`. Add the following Elasticsearch exporter as a child of the `zeebe`/`broker` configuration element: ``` @@ -183,5 +183,5 @@ Save the file. Without performing this step, no data will be visible in Operate It may take a few minutes for startup to complete. When the message `Started StandaloneCamunda in ___ seconds` is displayed, the application is ready to use. :::tip -Operate can be found at `http://localhost:8080/` and Tasklist can be found at `http://localhost:8080/tasklist`. Both use a default username/password of `demo`/`demo`. +Operate can be found at `http://localhost:8080/operate` and Tasklist can be found at `http://localhost:8080/tasklist`. Both use a default username/password of `demo`/`demo`. ::: diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 39bc86eed4..20d7a4f064 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -97,6 +97,12 @@ An incident represents an error condition which prevents Zeebe from advancing an - [Incident](/components/concepts/incidents.md) +### Ingress + +An Ingress is a Kubernetes object that manages external access to the services within a Kubernetes cluster. An **Ingress controller** is required to route traffic to your services according to the rules defined on the Ingress. + +- [Ingress setup](/self-managed/setup/guides/ingress-setup.md) + ### Job A job represents a distinct unit of work within a business process. Service tasks represent such @@ -162,7 +168,7 @@ BPMN model. ### Process instance -While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identitied by process instance ids. Executing process instances are also sometimes referred to as inflight processes. +While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identified by process instance ids. Executing process instances are also sometimes referred to as inflight processes. - [Processes](/components/concepts/processes.md) diff --git a/sidebars.js b/sidebars.js index ef0dc1fca8..5a0df7bf92 100644 --- a/sidebars.js +++ b/sidebars.js @@ -674,6 +674,7 @@ module.exports = { require("./docs/apis-tools/administration-api/sidebar-schema"), require("./docs/apis-tools/console-sm-api/sidebar-schema"), require("./docs/apis-tools/camunda-api-rest/sidebar-schema"), + require("./docs/apis-tools/operate-api/sidebar-schema"), { "Optimize API (REST)": [ optimizeLink("Overview", "apis-tools/optimize-api/overview/"), @@ -759,12 +760,11 @@ module.exports = { ), ], }, + require("./docs/apis-tools/tasklist-api-rest/sidebar-schema"), require("./docs/apis-tools/web-modeler-api/sidebar-schema"), require("./docs/apis-tools/zeebe-api/sidebar-schema"), { Deprecated: [ - require("./docs/apis-tools/operate-api/sidebar-schema"), - require("./docs/apis-tools/tasklist-api-rest/sidebar-schema"), require("./docs/apis-tools/tasklist-api/sidebar-schema"), require("./docs/apis-tools/zeebe-api-rest/sidebar-schema"), ], diff --git a/versioned_docs/version-8.2/components/concepts/backups.md b/versioned_docs/version-8.2/components/concepts/backups.md index 96aed17483..0aaf233545 100644 --- a/versioned_docs/version-8.2/components/concepts/backups.md +++ b/versioned_docs/version-8.2/components/concepts/backups.md @@ -35,7 +35,7 @@ Manual backups refer to the user-initiated process of creating a consistent snap ### Retention and rate limits -To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every five hours. +To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every hour. However, users can delete an existing backup to create a new one before the rate limit period ends. The system retains the three most recent completed backups per cluster. Failed backup attempts do not count towards the retention count. When a new backup is successful and the retention count is reached, the oldest backup is automatically deleted. diff --git a/versioned_docs/version-8.2/reference/glossary.md b/versioned_docs/version-8.2/reference/glossary.md index d4efb44de8..9656d8b5f9 100644 --- a/versioned_docs/version-8.2/reference/glossary.md +++ b/versioned_docs/version-8.2/reference/glossary.md @@ -97,6 +97,12 @@ An incident represents an error condition which prevents Zeebe from advancing an - [Incident](/components/concepts/incidents.md) +### Ingress + +An Ingress is a Kubernetes object that manages external access to the services within a Kubernetes cluster. An **Ingress controller** is required to route traffic to your services according to the rules defined on the Ingress. + +- [Ingress setup](/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md) + ### Job A job represents a distinct unit of work within a business process. Service tasks represent such @@ -162,7 +168,7 @@ BPMN model. ### Process instance -While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identitied by process instance ids. Executing process instances are also sometimes referred to as inflight processes. +While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identified by process instance ids. Executing process instances are also sometimes referred to as inflight processes. - [Processes](/components/concepts/processes.md) diff --git a/versioned_docs/version-8.3/components/concepts/backups.md b/versioned_docs/version-8.3/components/concepts/backups.md index 96aed17483..0aaf233545 100644 --- a/versioned_docs/version-8.3/components/concepts/backups.md +++ b/versioned_docs/version-8.3/components/concepts/backups.md @@ -35,7 +35,7 @@ Manual backups refer to the user-initiated process of creating a consistent snap ### Retention and rate limits -To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every five hours. +To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every hour. However, users can delete an existing backup to create a new one before the rate limit period ends. The system retains the three most recent completed backups per cluster. Failed backup attempts do not count towards the retention count. When a new backup is successful and the retention count is reached, the oldest backup is automatically deleted. diff --git a/versioned_docs/version-8.3/reference/glossary.md b/versioned_docs/version-8.3/reference/glossary.md index a5d004f2b8..d9791ba3d6 100644 --- a/versioned_docs/version-8.3/reference/glossary.md +++ b/versioned_docs/version-8.3/reference/glossary.md @@ -97,6 +97,12 @@ An incident represents an error condition which prevents Zeebe from advancing an - [Incident](/components/concepts/incidents.md) +### Ingress + +An Ingress is a Kubernetes object that manages external access to the services within a Kubernetes cluster. An **Ingress controller** is required to route traffic to your services according to the rules defined on the Ingress. + +- [Ingress setup](/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md) + ### Job A job represents a distinct unit of work within a business process. Service tasks represent such @@ -162,7 +168,7 @@ BPMN model. ### Process instance -While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identitied by process instance ids. Executing process instances are also sometimes referred to as inflight processes. +While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identified by process instance ids. Executing process instances are also sometimes referred to as inflight processes. - [Processes](/components/concepts/processes.md) diff --git a/versioned_docs/version-8.4/components/concepts/backups.md b/versioned_docs/version-8.4/components/concepts/backups.md index 96aed17483..0aaf233545 100644 --- a/versioned_docs/version-8.4/components/concepts/backups.md +++ b/versioned_docs/version-8.4/components/concepts/backups.md @@ -35,7 +35,7 @@ Manual backups refer to the user-initiated process of creating a consistent snap ### Retention and rate limits -To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every five hours. +To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every hour. However, users can delete an existing backup to create a new one before the rate limit period ends. The system retains the three most recent completed backups per cluster. Failed backup attempts do not count towards the retention count. When a new backup is successful and the retention count is reached, the oldest backup is automatically deleted. diff --git a/versioned_docs/version-8.4/reference/glossary.md b/versioned_docs/version-8.4/reference/glossary.md index dda2cb388e..ff252b08ce 100644 --- a/versioned_docs/version-8.4/reference/glossary.md +++ b/versioned_docs/version-8.4/reference/glossary.md @@ -97,6 +97,12 @@ An incident represents an error condition which prevents Zeebe from advancing an - [Incident](/components/concepts/incidents.md) +### Ingress + +An Ingress is a Kubernetes object that manages external access to the services within a Kubernetes cluster. An **Ingress controller** is required to route traffic to your services according to the rules defined on the Ingress. + +- [Ingress setup](/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md) + ### Job A job represents a distinct unit of work within a business process. Service tasks represent such @@ -162,7 +168,7 @@ BPMN model. ### Process instance -While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identitied by process instance ids. Executing process instances are also sometimes referred to as inflight processes. +While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identified by process instance ids. Executing process instances are also sometimes referred to as inflight processes. - [Processes](/components/concepts/processes.md) diff --git a/versioned_docs/version-8.5/components/concepts/backups.md b/versioned_docs/version-8.5/components/concepts/backups.md index df854ec93d..2dd8a7d263 100644 --- a/versioned_docs/version-8.5/components/concepts/backups.md +++ b/versioned_docs/version-8.5/components/concepts/backups.md @@ -35,7 +35,7 @@ Manual backups refer to the user-initiated process of creating a consistent snap ### Retention and rate limits -To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every five hours. +To ensure system stability, backup operations are subject to rate limits. Specifically, you can perform a backup operation every hour. However, users can delete an existing backup to create a new one before the rate limit period ends. The system retains the three most recent completed backups per cluster. Failed backup attempts do not count towards the retention count. When a new backup is successful and the retention count is reached, the oldest backup is automatically deleted. diff --git a/versioned_docs/version-8.5/guides/getting-started-java-spring.md b/versioned_docs/version-8.5/guides/getting-started-java-spring.md index 19a5f89b19..63d6251b14 100644 --- a/versioned_docs/version-8.5/guides/getting-started-java-spring.md +++ b/versioned_docs/version-8.5/guides/getting-started-java-spring.md @@ -128,7 +128,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too ``` -2. Add the following dependency to your `pom.xml` file: +2. Add the following dependency to your `pom.xml` file, as a child of the `` element: ``` @@ -190,7 +190,24 @@ In your terminal, run `mvn spring-boot:run`, where you should see the `charging To start a process instance programmatically, take the following steps: -1. In `ProcessPaymentsApplication.java`, convert the application to a `CommandLineRunner`, by adding `implements CommandLineRunner` to the `ProcessPaymentsApplication` class declaration. Instantiate a static `Logger` variable, and an instance variable named `zeebeClient` with the `@Autowired` annotation. +1. In `ProcessPaymentsApplication.java`, add the following dependencies after the package definition: + +```java +package io.camunda.demo.process_payments; + +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +import io.camunda.zeebe.client.ZeebeClient; +import io.camunda.zeebe.spring.client.annotation.Deployment; +``` + +2. Convert the application to a `CommandLineRunner`, by adding `implements CommandLineRunner` to the `ProcessPaymentsApplication` class declaration. Instantiate a static `Logger` variable, and an instance variable named `zeebeClient` with the `@Autowired` annotation. ```java @SpringBootApplication @@ -208,7 +225,7 @@ public class ProcessPaymentsApplication implements CommandLineRunner { } ``` -2. Implement an overriding `run` method in `ProcessPaymentsApplication`. When the application runs, it will create a new `process-payments` process instance, of the latest version, with specified variables, and send it to our local Self-Managed instance: +3. Implement an overriding `run` method in `ProcessPaymentsApplication`. When the application runs, it will create a new `process-payments` process instance, of the latest version, with specified variables, and send it to our local Self-Managed instance: ```java @Override diff --git a/versioned_docs/version-8.5/reference/glossary.md b/versioned_docs/version-8.5/reference/glossary.md index 39bc86eed4..20d7a4f064 100644 --- a/versioned_docs/version-8.5/reference/glossary.md +++ b/versioned_docs/version-8.5/reference/glossary.md @@ -97,6 +97,12 @@ An incident represents an error condition which prevents Zeebe from advancing an - [Incident](/components/concepts/incidents.md) +### Ingress + +An Ingress is a Kubernetes object that manages external access to the services within a Kubernetes cluster. An **Ingress controller** is required to route traffic to your services according to the rules defined on the Ingress. + +- [Ingress setup](/self-managed/setup/guides/ingress-setup.md) + ### Job A job represents a distinct unit of work within a business process. Service tasks represent such @@ -162,7 +168,7 @@ BPMN model. ### Process instance -While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identitied by process instance ids. Executing process instances are also sometimes referred to as inflight processes. +While a process represents a defined sequence of distinct steps representing your business logic, a process instance represents a currently executing or completed process. For a single process, there could be many associated process instances in various stages of their executing lifecycle. Process instances are identified by process instance ids. Executing process instances are also sometimes referred to as inflight processes. - [Processes](/components/concepts/processes.md)