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
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ listener grpc:Listener grpcListener = new (9090,
```

:::tip Generating certificates
For instructions on generating certificates using `keytool`, see [Keystores and Truststores](../../../../deploy-operate/secure/keystore-truststore.md).
For instructions on generating certificates using `keytool`, see Keystores and Truststores.
:::

**Listener with mutual TLS:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ listener tcp:Listener tcpListener = new (3000, secureSocket = {
```

:::tip Generating certificates
For instructions on generating certificates using `keytool`, see [Keystores and Truststores](../../../../deploy-operate/secure/keystore-truststore.md).
For instructions on generating certificates using `keytool`, see Keystores and Truststores.
:::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ Managed Kafka services (Confluent Cloud, Amazon MSK, Azure Event Hubs) provide t

For encrypted connections:

1. Generate a CA certificate, server certificate, and key, or obtain them from your PKI. See [Keystores and Truststores](../../../../deploy-operate/secure/keystore-truststore.md) for step-by-step instructions using `keytool`.
1. Generate a CA certificate, server certificate, and key, or obtain them from your PKI. See Keystores and Truststores for step-by-step instructions using `keytool`.
2. Configure the broker's `server.properties` with the keystore and truststore paths.
3. Note the **truststore/certificate file path** and **keystore credentials**; you will use these when configuring the Ballerina connector.
1 change: 1 addition & 0 deletions en/docs/deploy-operate/capacity-planning/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
title: Overview and Sizing Guidelines
description: Estimate CPU, memory, replica counts, and connection requirements for WSO2 Integrator deployments based on measured performance data.
keywords: [wso2 integrator, capacity planning, sizing, resource estimation, throughput, scaling]
draft: true
---

# Overview and Sizing Guidelines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 2
title: Performance Benchmarks
description: Benchmark results for the WSO2 Integrator HTTP passthrough scenario, including throughput limits, response latency, and resource optimization recommendations.
keywords: [wso2 integrator, performance, benchmarks, throughput, latency, capacity planning, http passthrough]
draft: true
---

# Performance Benchmarks
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/cicd/azure-devops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Azure DevOps
description: CI/CD pipeline with Azure DevOps for WSO2 Integrator.
draft: true
---

# Azure DevOps
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/cicd/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: GitHub Actions
description: CI/CD pipeline with GitHub Actions for WSO2 Integrator.
draft: true
---

# GitHub Actions
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/cicd/gitlab.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: GitLab CI/CD
description: CI/CD pipeline with GitLab for WSO2 Integrator.
draft: true
---

# GitLab CI/CD
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/cicd/jenkins.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Jenkins
description: CI/CD pipeline with Jenkins for WSO2 Integrator.
draft: true
---

# Jenkins
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/deploy/aws-azure-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 4
title: Deploy to AWS / Azure / GCP
description: Deploy integrations to major cloud providers.
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# Deploy to AWS / Azure / GCP
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/deploy/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 5
title: Environments
description: Manage Dev, Test, and Prod environments with configuration promotion.
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# Environments (Dev, Test, Prod)
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/deploy/graalvm-native-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 9
title: GraalVM Native Images
description: Compile Ballerina integrations to GraalVM native binaries for instant startup and reduced memory.
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# GraalVM Native Images
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 6
title: Scaling & High Availability
description: Scale integrations horizontally and ensure high availability.
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# Scaling & High Availability
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/deploy/serverless-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 8
title: Serverless Deployment
description: Deploy integrations as serverless functions on AWS Lambda and Azure Functions.
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# Serverless Deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 1
title: Integration Control Plane
description: Monitor and manage running integrations with the Integration Control Plane (ICP).
draft: true
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 1
title: Jaeger
description: Set up Jaeger for distributed tracing of WSO2 Integrator services.
draft: true
---

# Jaeger
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/logging-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
title: Logging
description: Configure logging, log levels, and log aggregation for WSO2 Integrator.
draft: true
---

# Logging
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/metrics-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 3
title: Metrics
description: Enable and expose Prometheus metrics from WSO2 Integrator for monitoring health and performance.
draft: true
---

# Metrics
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/moesif-api-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 4
title: Moesif
description: Observe metrics, traces, and logs from WSO2 Integrator using Moesif API analytics.
draft: true
---

# Moesif
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/new-relic-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 3
title: New Relic
description: Observe metrics and distributed traces from WSO2 Integrator using New Relic.
draft: true
---

# New Relic
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/observability-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 1
title: Observability Overview
description: Overview of observability capabilities for WSO2 Integrator -- metrics, logging, and distributed tracing.
draft: true
---

# Observability Overview
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/recipe-datadog-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
title: Datadog
description: Observe metrics and distributed traces from WSO2 Integrator using Datadog.
draft: true
---

# Datadog
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/observe/zipkin-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
title: Zipkin
description: Set up Zipkin for distributed tracing of WSO2 Integrator services.
draft: true
---

# Zipkin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 5
title: API Security and Rate Limiting
description: Rate limiting, input validation, and request hardening for production APIs in WSO2 Integrator.
keywords: [wso2 integrator, api security, rate limiting, cors, input validation, security headers]
draft: true
---

# API Security and Rate Limiting
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/secure/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 3
title: Authentication
description: Configure OAuth 2.0, JWT, and mTLS authentication for production services in WSO2 Integrator.
keywords: [wso2 integrator, authentication, oauth 2.0, jwt, mtls, security]
draft: true
---

# Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 8
title: Compliance Considerations
description: Audit logging, data residency, and compliance configurations for WSO2 Integrator services.
keywords: [wso2 integrator, compliance, gdpr, hipaa, soc 2, audit logging, data residency, pii]
draft: true
---

# Compliance Considerations
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/secure/ip-whitelisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 7
title: IP Whitelisting
description: Configure IP-based access control to restrict service access to trusted addresses in WSO2 Integrator.
keywords: [wso2 integrator, ip whitelisting, ip filtering, cidr, network policy, access control]
draft: true
---

# IP Whitelisting
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/secure/keystore-truststore.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
title: Keystores and Truststores
description: Create, configure, and manage keystores and truststores for TLS, mutual TLS, and secure connections in WSO2 Integrator.
keywords: [wso2 integrator, keystore, truststore, tls, mtls, security, certificates]
draft: true
---

# Keystores and Truststores
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/secure/runtime-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 2
title: Runtime Security
description: Best practices for securing integrations in WSO2 Integrator at runtime, including JVM hardening, keystores, non-root execution, and network policies.
keywords: [wso2 integrator, runtime security, jvm hardening, non-root, container security, network policy]
draft: true
---

# Runtime Security
Expand Down
1 change: 1 addition & 0 deletions en/docs/deploy-operate/secure/secrets-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 6
title: Secrets and Encryption
description: Manage secrets and configure encryption at rest and in transit for WSO2 Integrator services.
keywords: [wso2 integrator, secrets, encryption, config.toml, vault, kubernetes secrets, tls]
draft: true
---

# Secrets and Encryption
Expand Down
42 changes: 21 additions & 21 deletions en/docs/deploy/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,44 @@ WSO2 Integrator supports multiple deployment targets. Choose the one that fits y
- **[Run locally](./self-hosted/run-locally.md)** — Run your integration on your local machine for development or testing.
- **[VM-based deployment](../deploy-operate/deploy/vm-based-deployment.md)** — Deploy to a virtual machine or bare-metal server.
- **[Docker](./self-hosted/docker.md)** and **[Kubernetes](./self-hosted/kubernetes.md)** — Package your integration as a container and deploy it to a Kubernetes cluster.
- **[Red Hat OpenShift](./self-hosted/openshift.md)** — Deploy on OpenShift using standard Kubernetes tooling.
- **[Serverless deployment](../deploy-operate/deploy/serverless-deployment.md)** — Run integrations as serverless functions.
- **[AWS, Azure, and GCP](../deploy-operate/deploy/aws-azure-gcp.md)** — Deploy to major cloud providers using native services.
- **[GraalVM native images](../deploy-operate/deploy/graalvm-native-images.md)** — Compile your integration to a native binary for faster startup and lower memory usage.
- **Red Hat OpenShift** — Deploy on OpenShift using standard Kubernetes tooling.
- **Serverless deployment** — Run integrations as serverless functions.
- **AWS, Azure, and GCP** — Deploy to major cloud providers using native services.
- **GraalVM native images** — Compile your integration to a native binary for faster startup and lower memory usage.

## Configuration and scaling

- **[Environments](../deploy-operate/deploy/environments.md)** — Manage dev, staging, and production environment configurations.
- **Environments** — Manage dev, staging, and production environment configurations.
- **[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.
- **Scaling and high availability** — Design your deployment for resilience and scale.
- **Capacity planning** — Estimate resource requirements and plan deployment sizing.

## CI/CD

Automate your deployment pipeline using your preferred CI/CD platform:

- [GitHub Actions](../deploy-operate/cicd/github-actions.md)
- [Jenkins](../deploy-operate/cicd/jenkins.md)
- [GitLab](../deploy-operate/cicd/gitlab.md)
- [Azure DevOps](../deploy-operate/cicd/azure-devops.md)
- GitHub Actions
- Jenkins
- GitLab
- Azure DevOps

## 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.
- **Observability overview** — Understand the observability model.
- **Logging overview** — Capture and query structured log output.
- **Metrics overview** — 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.
- **Jaeger** and **Zipkin** tracing — Distributed request tracing.
- **[Datadog](../deploy-operate/observe/datadog-integration.md)**, **New Relic**, **[Elastic Stack (ELK)](../deploy-operate/observe/elastic-stack-elk.md)**, **[OpenSearch](../deploy-operate/observe/opensearch-integration.md)**, **Moesif** — 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.
- **Runtime security** — Harden the runtime environment.
- **Authentication** — Secure service endpoints.
- **API security and rate limiting** — Enforce access policies.
- **Secrets and encryption** — Manage sensitive credentials safely.
- **Compliance considerations** — Meet regulatory and audit requirements.
4 changes: 2 additions & 2 deletions en/docs/deploy/self-hosted/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ WSO2 Integrator uses the Ballerina Code to Cloud feature to generate a Docker im

:::info Prerequisites
- [Docker](https://www.docker.com/) installed and running on your build machine
- A WSO2 Integrator project based on Ballerina
- A WSO2 Integrator project
:::

:::note
Expand Down Expand Up @@ -130,4 +130,4 @@ curl http://localhost:9090/helloWorld/sayHello
## What's next

- [Kubernetes](./kubernetes.md) — Generate Kubernetes manifests and deploy to a cluster using Code to Cloud
- [Red Hat OpenShift](./openshift.md) — Generate OpenShift manifests and deploy using the `oc` CLI
- Red Hat OpenShift — Generate OpenShift manifests and deploy using the `oc` CLI
4 changes: 2 additions & 2 deletions en/docs/deploy/self-hosted/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ WSO2 Integrator uses the Ballerina Code to Cloud feature to generate Kubernetes
:::info Prerequisites
- [Docker](https://www.docker.com/) installed and running on your build machine
- [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured against a Kubernetes cluster
- A WSO2 Integrator project based on Ballerina
- A WSO2 Integrator project
:::

:::note
Expand Down Expand Up @@ -218,4 +218,4 @@ Code to Cloud does not expose every Kubernetes configuration option. For changes
## What's next

- [Docker](./docker.md) — Build a Docker image from your project using Code to Cloud
- [Red Hat OpenShift](./openshift.md) — Generate OpenShift manifests and deploy using the `oc` CLI
- Red Hat OpenShift — Generate OpenShift manifests and deploy using the `oc` CLI
3 changes: 2 additions & 1 deletion en/docs/deploy/self-hosted/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Red Hat OpenShift
description: Deploy a WSO2 Integrator project to Red Hat OpenShift using the Ballerina Code to Cloud feature.
keywords: [wso2 integrator, openshift, red hat, containerized deployment, code to cloud, bal build, cloud.toml, oc]
draft: true
Comment thread
pcnfernando marked this conversation as resolved.
---

# Red Hat OpenShift
Expand All @@ -11,7 +12,7 @@ WSO2 Integrator uses the Ballerina Code to Cloud feature to generate OpenShift m
:::info Prerequisites
- [Docker](https://www.docker.com/) installed and running on your build machine
- [OpenShift CLI (`oc`)](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html) installed and logged in to your cluster
- A WSO2 Integrator project based on Ballerina
- A WSO2 Integrator project
:::

:::note
Expand Down
4 changes: 2 additions & 2 deletions en/docs/deploy/self-hosted/run-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page explains how to run a WSO2 Integrator project using the Ballerina CLI.

:::info Prerequisites
- [Ballerina installed](https://ballerina.io/downloads/) on any machine where you want to run the project
- A WSO2 Integrator project based on Ballerina
- A WSO2 Integrator project
:::

## Run locally
Expand Down Expand Up @@ -72,4 +72,4 @@ Ballerina must be installed on the VM. Download it from [ballerina.io](https://b

- [Docker](./docker.md) — Build a Docker image from your project using Code to Cloud
- [Kubernetes](./kubernetes.md) — Generate Kubernetes manifests and deploy to a cluster using Code to Cloud
- [Red Hat OpenShift](./openshift.md) — Generate OpenShift manifests and deploy using the `oc` CLI
- Red Hat OpenShift — Generate OpenShift manifests and deploy using the `oc` CLI
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,4 @@ The coordination database sits on the file-processing data path: its availabilit
## What's next

- [FTP / SFTP](ftp-sftp.md) — service, listener, and file-handler reference
- [Scaling and high availability](../../../deploy-operate/deploy/scaling-high-availability.md) — deployment-level scaling and HA strategies
- Scaling and high availability — deployment-level scaling and HA strategies
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,13 @@ For the complete configuration reference (supported types, value sources, resolu

| Practice | Description |
|---|---|
| **Never commit the Config.toml file** | Keep the `Config.toml` file out of version control. See [Secrets and encryption](../../../deploy-operate/secure/secrets-encryption.md). |
| **Never commit the Config.toml file** | Keep the `Config.toml` file out of version control. See Secrets and encryption. |
| **Mark required values explicitly** | For configurations that must come from the environment (such as endpoints and credentials), leave **Default Value** empty in the Visual Designer and use `?` in code so that the value is mandated and absence causes startup to fail. |
| **Group related settings** | Use record types to group settings that belong to the same subsystem (for example, database configuration or CRM settings). |
| **Document defaults** | Use the **Documentation** field to explain the purpose and valid range of each setting. |

## What's next

- [Configuration management](../../../reference/config/configuration-management.md) — Complete configuration reference: value sources, precedence, and environment variables.
- [Secrets and encryption](../../../deploy-operate/secure/secrets-encryption.md) — Securely manage credentials and other sensitive values.
- Secrets and encryption — Securely manage credentials and other sensitive values.
- [Connections](connections.md) — Use configurable variables to parameterize connections.
Loading
Loading