Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions en/docs/deploy/cloud/deploy-from-cloud-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ WSO2 Cloud pushes the integration to the repository, builds it, and deploys it t
## What's next

- [View and manage integrations](../../manage/cloud/integrations.md) — Inspect build status, deployment status, and manage the lifecycle of your deployed integrations.
- [CI/CD overview](../../manage/cloud/cicd/overview.md) — From here on, every commit to the connected branch automatically triggers a new build and deployment. Learn how Git-triggered deployments and deployment pipelines work.
- [Runtime configurations](../../manage/cloud/configurations/runtime-configurations.md) — Set configurable values per environment and manage reusable configuration groups.
- [Security configurations](../../manage/cloud/configurations/security-configurations.md) — Secure your integration endpoints with API Key or OAuth2 authentication.
- [Endpoint configurations](../../manage/cloud/configurations/endpoint-configurations.md) — Control endpoint visibility levels for integrations deployed as Integration as APIs.
1 change: 1 addition & 0 deletions en/docs/deploy/cloud/import-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ WSO2 Cloud starts the build immediately. Once the build completes, the integrati
## What's next

- [View and manage integrations](../../manage/cloud/integrations.md) — Inspect build status, deployment status, and manage the lifecycle of your deployed integrations.
- [CI/CD overview](../../manage/cloud/cicd/overview.md) — From here on, every commit to the connected branch automatically triggers a new build and deployment. Learn how Git-triggered deployments and deployment pipelines work.
- [Runtime configurations](../../manage/cloud/configurations/runtime-configurations.md) — Set configurable values per environment and manage reusable configuration groups.
- [Security configurations](../../manage/cloud/configurations/security-configurations.md) — Secure your integration endpoints with API Key or OAuth2 authentication.
- [Endpoint configurations](../../manage/cloud/configurations/endpoint-configurations.md) — Control endpoint visibility levels for integrations deployed as Integration as APIs.
1 change: 1 addition & 0 deletions en/docs/deploy/cloud/import-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ WSO2 Cloud creates all the integrations and navigates you to the newly created p

- [View and manage integrations](../../manage/cloud/integrations.md) — Inspect build status, deployment status, and manage the lifecycle of your deployed integrations.
- [View and manage projects](../../manage/cloud/projects.md) — Create, view, edit, and delete projects on WSO2 Cloud.
- [CI/CD overview](../../manage/cloud/cicd/overview.md) — From here on, every commit to the connected branch automatically triggers a new build and deployment. Learn how Git-triggered deployments and deployment pipelines work.
- [Runtime configurations](../../manage/cloud/configurations/runtime-configurations.md) — Set configurable values per environment and manage reusable configuration groups.
- [Security configurations](../../manage/cloud/configurations/security-configurations.md) — Secure your integration endpoints with API Key or OAuth2 authentication.
- [Endpoint configurations](../../manage/cloud/configurations/endpoint-configurations.md) — Control endpoint visibility levels for integrations deployed as Integration as APIs.
17 changes: 6 additions & 11 deletions en/docs/deploy/cloud/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,20 @@ description: Overview of the ways to deploy integrations to WSO2 Cloud from the
keywords: [wso2 integrator, wso2 cloud, deploy, overview, import, cloud editor]
---

# WSO2 Cloud - Integration Platform
# Deploy to WSO2 Cloud

WSO2 Cloud - Integration Platform is a fully managed platform that builds and runs your integrations from a Git repository. There are three ways to get your integrations onto WSO2 Cloud, depending on where your work lives.

## Deploy from the IDE
## Build with WSO2 Integrator

If you are building your integration locally with the WSO2 Integrator IDE, you can push it to WSO2 Cloud directly from the IDE. You can deploy a single integration or all integrations in a project at once.
WSO2 Integrator is the same IDE whether you install it locally or launch it in the browser as the WSO2 Cloud editor. Either way, you design and build your integration with the same visual designer and pro-code editor, then deploy it to WSO2 Cloud without leaving the IDE.

[Deploy from the IDE](push-from-ide.md)
- [Deploy from the IDE](push-from-ide.md) — Push a single integration or an entire project to WSO2 Cloud directly from the locally installed WSO2 Integrator IDE.
- [Deploy from the cloud editor](deploy-from-cloud-editor.md) — Build and deploy your integration entirely in the browser, without installing anything locally.

## Import from a repository

If you already have an integration or project in a Git repository, you can import it into WSO2 Cloud without going through the IDE. WSO2 Cloud connects to your repository, builds the integration, and deploys it to the Development environment automatically.
If you already have an integration or project in a Git repository, you can import it into WSO2 Cloud without going through WSO2 Integrator. WSO2 Cloud connects to your repository, builds the integration, and deploys it to the Development environment automatically.

- [Import a project](import-project.md) — Import a whole WSO2 Integrator project and configure all its integrations at once.
- [Import an integration](import-integration.md) — Import a single integration from an existing repository.

## Develop and deploy in the cloud editor

WSO2 Cloud includes a browser-based editor where you can build integrations without installing anything locally. When your integration is ready, you save and deploy it to WSO2 Cloud from within the editor.

[Deploy from the cloud editor](deploy-from-cloud-editor.md)
1 change: 1 addition & 0 deletions en/docs/deploy/cloud/push-from-ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ A browser opens showing the deployed integration directly on WSO2 Cloud.
## What's next

- [View and manage integrations](../../manage/cloud/integrations.md) — Inspect build status, deployment status, and manage the lifecycle of your deployed integrations.
- [CI/CD overview](../../manage/cloud/cicd/overview.md) — From here on, every commit to the connected branch automatically triggers a new build and deployment. Learn how Git-triggered deployments and deployment pipelines work.
- [Runtime configurations](../../manage/cloud/configurations/runtime-configurations.md) — Set configurable values per environment and manage reusable configuration groups.
- [Security configurations](../../manage/cloud/configurations/security-configurations.md) — Secure your integration endpoints with API Key or OAuth2 authentication.
- [Endpoint configurations](../../manage/cloud/configurations/endpoint-configurations.md) — Control endpoint visibility levels for integrations deployed as Integration as APIs.
49 changes: 14 additions & 35 deletions en/docs/deploy/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,27 @@ title: Deploy Overview
description: Learn about the different deployment options for your WSO2 Integrator projects and how to choose the right one for your needs.
keywords: [wso2 integrator, deployment, wso2 cloud, docker, kubernetes, vm-based deployment, integration control plane]
---
{/* TODO: Work in progress */}
# Deploy

# Deploy and Operate
Once your integration is ready, choose how to ship and run it. WSO2 Integrator supports multiple deployment targets and CI/CD options.

Once your integration is ready, this section covers everything you need to ship it, keep it running, and operate it in production.
## WSO2 Cloud

## Deployment options
Deploy to WSO2 Cloud - Integration Platform, a fully managed SaaS. No infrastructure setup required.

WSO2 Integrator supports multiple deployment targets. Choose the one that fits your infrastructure:
- **[Deploy from the IDE](./cloud/push-from-ide.md)** — Push directly from the locally installed WSO2 Integrator IDE.
- **[Deploy from the cloud editor](./cloud/deploy-from-cloud-editor.md)** — Build and deploy entirely in the browser.
- **[Import a project](./cloud/import-project.md)** — Import an existing project from a Git repository.
- **[Import an integration](./cloud/import-integration.md)** — Import a single integration from an existing repository.

- **[WSO2 Cloud](./cloud/overview.md)** — Push your project directly from the IDE or the cloud editor to the managed WSO2 Integration Platform. No infrastructure setup required.
- **[VM Deployment](./self-hosted/vm-deployment.md)** — Deploy your integration to a virtual machine or bare-metal server as a standalone JAR file.
- **[Containerized Deployment](./self-hosted/containerized-deployment.md)** — Package your integration as a container and deploy it to Docker, Kubernetes, or Red Hat OpenShift.
- **[Serverless deployment](../deploy-operate/deploy/serverless-deployment.md)** — Run integrations as serverless functions.
- **[GraalVM native images](../deploy-operate/deploy/graalvm-native-images.md)** — Compile your integration to a native binary for faster startup and lower memory usage.
## Self-Hosted

## Configuration and scaling
Run your integration on your own infrastructure. Generate Docker images or Kubernetes manifests and deploy to any platform.

- **[Managing configurations](../deploy-operate/deploy/managing-configurations.md)** — Externalize and manage runtime configuration values.
- **[Scaling and high availability](../deploy-operate/deploy/scaling-high-availability.md)** — Design your deployment for resilience and scale.
- **[Capacity planning](../deploy-operate/capacity-planning/overview.md)** — Estimate resource requirements and plan deployment sizing.
- **[VM deployment](./self-hosted/vm-deployment.md)** — Run on your local machine, a VM, or bare-metal server.
- **[Containerized deployment](./self-hosted/containerized-deployment.md)** — Package as a container and deploy to Docker, Kubernetes, or Red Hat OpenShift.
- **[Serverless deployment](../deploy-operate/deploy/serverless-deployment.md)** — Run as serverless functions.
- **[GraalVM native images](../deploy-operate/deploy/graalvm-native-images.md)** — Compile to a native binary for faster startup and lower memory usage.

## CI/CD

Expand All @@ -33,24 +33,3 @@ Automate your deployment pipeline using your preferred CI/CD platform:
- [Jenkins](../deploy-operate/cicd/jenkins.md)
- [GitLab](../deploy-operate/cicd/gitlab.md)
- [Azure DevOps](../deploy-operate/cicd/azure-devops.md)

## Observability

Monitor your integrations in production with logs, metrics, and traces:

- **[Observability overview](../deploy-operate/observe/observability-overview.md)** — Understand the observability model.
- **[Logging overview](../deploy-operate/observe/logging-overview.md)** — Capture and query structured log output.
- **[Metrics overview](../deploy-operate/observe/metrics-overview.md)** — Emit application-level metrics.
- **[Prometheus and Grafana](../deploy-operate/observe/metrics-prometheus-grafana.md)** — Scrape metrics and build dashboards.
- **[Jaeger](../deploy-operate/observe/jaeger-distributed-tracing.md)** and **[Zipkin](../deploy-operate/observe/zipkin-tracing.md)** tracing — Distributed request tracing.
- **[Datadog](../deploy-operate/observe/datadog-integration.md)**, **[New Relic](../deploy-operate/observe/new-relic-integration.md)**, **[Elastic Stack (ELK)](../deploy-operate/observe/elastic-stack-elk.md)**, **[OpenSearch](../deploy-operate/observe/opensearch-integration.md)**, **[Moesif](../deploy-operate/observe/moesif-api-analytics.md)** — Third-party observability platforms.

## Security

Protect your integrations and the data they process:

- **[Runtime security](../deploy-operate/secure/runtime-security.md)** — Harden the runtime environment.
- **[Authentication](../deploy-operate/secure/authentication.md)** — Secure service endpoints.
- **[API security and rate limiting](../deploy-operate/secure/api-security-rate-limiting.md)** — Enforce access policies.
- **[Secrets and encryption](../deploy-operate/secure/secrets-encryption.md)** — Manage sensitive credentials safely.
- **[Compliance considerations](../deploy-operate/secure/compliance-considerations.md)** — Meet regulatory and audit requirements.
2 changes: 1 addition & 1 deletion en/docs/get-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The data plane can be:

- **WSO2-managed:** Provisioned and operated by WSO2 as part of WSO2 Integration Cloud.
- **Private (cloud):** Running in your own AWS, Azure, GCP, OpenShift, or Kubernetes environment, but still managed through WSO2 Integration Cloud's control plane.
- **Self-hosted:** Running entirely on your own infrastructure, managed end-to-end by you.
- **Self-Hosted:** Running entirely on your own infrastructure, managed end-to-end by you.

### Observability plane

Expand Down
4 changes: 3 additions & 1 deletion en/docs/manage/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ The right choice depends on whether you want a fully managed service or full con
| | Description |
|---|---|
| [WSO2 Cloud - Integration Platform](./cloud/overview.md) | A fully managed SaaS control plane. Deploy integrations, configure environments, monitor with built-in observability, and control access, without managing any infrastructure. |
| [Integration Control Plane (ICP)](./icp/integration-control-plane.md) | A self-hosted management server for on-premises, private cloud, or air-gapped deployments. Connects to your WSO2 Integrator runtimes and provides a centralized dashboard and API. |
| [Integration Control Plane (ICP)](./icp/integration-control-plane.md) | A self-hosted control plane for on-premises, private cloud, or air-gapped deployments. Connects to your WSO2 Integrator runtimes and provides a centralized dashboard and API. |
| Custom & Third-Party Setups | Operational tooling that works independently of both control planes — observability integrations (Prometheus, Jaeger, Datadog, New Relic) and runtime security configuration. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we make this Third-Party observability tools? and make runtime security configuration a separate section too?

| Capacity Planning | Sizing guidelines and resource estimation for any deployment model — WSO2 Cloud, ICP, or self-hosted. |

## What's next

Expand Down
123 changes: 64 additions & 59 deletions en/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ const sidebars: SidebarsConfig = {
// WSO2 Cloud
{
type: 'category',
label: 'Deploy to WSO2 Cloud',
label: 'WSO2 Cloud',
link: { type: 'doc', id: 'deploy/cloud/overview' },
items: [
'deploy/cloud/push-from-ide',
Expand All @@ -1896,11 +1896,7 @@ const sidebars: SidebarsConfig = {
'deploy/cloud/import-integration',
],
},
// Self-hosted: upstream has migrated run-locally / docker /
// kubernetes / openshift to deploy/self-hosted/*. The remaining
// legacy deploy-operate/deploy/* docs that don't have a new
// home yet are listed alongside so they stay reachable until
// they're migrated too.
// Self-Hosted
{
type: 'category',
label: 'Self-Hosted',
Expand All @@ -1909,8 +1905,6 @@ const sidebars: SidebarsConfig = {
'deploy/self-hosted/containerized-deployment',
'deploy-operate/deploy/serverless-deployment',
'deploy-operate/deploy/graalvm-native-images',
'deploy-operate/deploy/managing-configurations',
'deploy-operate/deploy/scaling-high-availability',
],
},
// CI/CD
Expand All @@ -1924,57 +1918,6 @@ const sidebars: SidebarsConfig = {
'deploy-operate/cicd/azure-devops',
],
},
// Observe
{
type: 'category',
label: 'Observe',
items: [
'deploy-operate/observe/observability-overview',
'deploy-operate/observe/metrics-overview',
'deploy-operate/observe/logging-overview',
{
type: 'category',
label: 'Distributed Tracing',
items: [
'deploy-operate/observe/jaeger-distributed-tracing',
'deploy-operate/observe/zipkin-tracing',
],
},
{
type: 'category',
label: 'Supported Platforms',
items: [
'deploy-operate/observe/integration-control-plane-icp',
'deploy-operate/observe/recipe-datadog-setup',
'deploy-operate/observe/new-relic-integration',
'deploy-operate/observe/moesif-api-analytics',
],
},
],
},
// Secure
{
type: 'category',
label: 'Secure',
items: [
'deploy-operate/secure/keystore-truststore',
'deploy-operate/secure/runtime-security',
'deploy-operate/secure/authentication',
'deploy-operate/secure/api-security-rate-limiting',
'deploy-operate/secure/secrets-encryption',
'deploy-operate/secure/ip-whitelisting',
'deploy-operate/secure/compliance-considerations',
],
},
// Capacity Planning
{
type: 'category',
label: 'Capacity Planning',
items: [
'deploy-operate/capacity-planning/overview',
'deploy-operate/capacity-planning/performance-benchmarks',
],
},
],
},

Expand Down Expand Up @@ -2138,6 +2081,68 @@ const sidebars: SidebarsConfig = {
},
],
},
// Custom & Third-Party Setups: operational tooling independent of
// both WSO2 Cloud and ICP control planes.
{
type: 'category',
label: 'Custom & Third-Party Setups',
items: [
// Self-Hosted runtime management
'deploy-operate/deploy/managing-configurations',
'deploy-operate/deploy/scaling-high-availability',
// Observability
{
type: 'category',
label: 'Observe',
items: [
'deploy-operate/observe/observability-overview',
'deploy-operate/observe/metrics-overview',
'deploy-operate/observe/logging-overview',
{
type: 'category',
label: 'Distributed Tracing',
items: [
'deploy-operate/observe/jaeger-distributed-tracing',
'deploy-operate/observe/zipkin-tracing',
],
},
{
type: 'category',
label: 'Third-Party Platforms',
items: [
'deploy-operate/observe/integration-control-plane-icp',
'deploy-operate/observe/recipe-datadog-setup',
'deploy-operate/observe/new-relic-integration',
'deploy-operate/observe/moesif-api-analytics',
],
},
],
},
// Security
{
type: 'category',
label: 'Secure',
items: [
'deploy-operate/secure/keystore-truststore',
'deploy-operate/secure/runtime-security',
'deploy-operate/secure/authentication',
'deploy-operate/secure/api-security-rate-limiting',
'deploy-operate/secure/secrets-encryption',
'deploy-operate/secure/ip-whitelisting',
'deploy-operate/secure/compliance-considerations',
],
},
],
},
// Capacity Planning: relevant across all deployment and management options.
{
type: 'category',
label: 'Capacity Planning',
items: [
'deploy-operate/capacity-planning/overview',
'deploy-operate/capacity-planning/performance-benchmarks',
],
},
],
},

Expand Down
Loading