Skip to content

Main Navigation Release Notes Support & Contribution Kyma on SAP Community

Appearance

Sidebar Navigation

Quick Install

Modules

Istio

Istio Service Mesh

Restart of Workloads in the Istio Service Mesh

Enabling Istio Sidecar Injection

Istio Version

Istio Proxy as Native Sidecar Container

Istio Custom Resource

Tutorials

Expose Workloads Using oauth2-proxy

Expose Workloads Using Gateway API

Expose a TCP Service Using Gateway API Aplha Support

Exposing Workloads Using Istio VirtualService

Configure Istio Access Logs

Send Requests Using Istio Egress Gateway

Send mTLS Requests Using Istio Egress Gateway

Migrate From ELB to NLB

Technical Reference

Istio Controller Parameters

Istio Controller RBAC Configuration

Troubleshooting

Network Connectivity - Basic Diagnostics

Connection Refused Errors

No Access Error

Istio Sidecar Injection Issues

Reverting the Istio module's deletion

SAP HANA Database Connection Issues

Not Found Error

Incompatible Istio Sidecar

Pods Created by Jobs Can't Finish

Init Containers Can't Access the Network

Modified Istio Resources

Istio Cannot Verify an HTTPS Certificate

API Gateway

Quick Start Guide

Tutorials

Create a Workload

Set Up a Custom Domain

Set Up a TLS Gateway

Set Up an mTLS Gateway

Expose a Workload

Use APIRule v2

Expose a Workload

Expose Multiple Workloads

Expose Workloads in Multiple Namespaces

Use a Short Host

Use APIRule v2alpha1

Expose a Workload

Expose Multiple Workloads

Expose Workloads in Multiple Namespaces

Use a Short Host

Use APIRule v1beta1

Expose a Workload

Expose Multiple Workloads

Expose Workloads in Multiple Namespaces

Expose and Secure a Workload

Use APIRule v2

Get JSON Web Tokens (JWT)

Secure a Workload with JWT

Secure a Workload with extAuth

Use APIRule v2alpha1

Get JSON Web Tokens (JWT)

Secure a Workload with JWT

Secure a Workload with extAuth

Use APIRule v1beta1

Secure a Workload with OAuth2

Get JSON Web Tokens (JWT)

Secure a Workload with JWT

Secure a Workload with Istio

Secure a Workload with a Certificate

Configure IP-Based Access with XFF

Security

Prepare Self-Signed Root CA and Client Certificates

Set Up a Custom Identity Provider

Configuring Local Rate Limiting

Custom Resources

APIGateway Custom Resource

Specification

Kyma Gateway

Oathkeeper Dependency

APIRule Custom Resource

v2

APIRule Access Strategies

v2alpha1

APIRule Access Strategies

v1beta1

Istio JWT Access Strategy

Comparison of Access Strategies

APIRule Mutators

APIRule Authorizations

RateLimit Custom Resource

APIRule Migration

Retrieve v1beta1 spec

Migrate jwt Handlers

Migrate noop, no_auth, allow Handlers

Migrate Ory-based Handlers

Changes in APIRule v2

FAQ

Technical Reference

Kyma API Gateway Operator Parameters

Ory Limitations

Api Gateway Request Flow

Troubleshooting Guides

Certificate Issuer Not Created

Kyma Gateway Not Reachable

Issues with Gardener Certificates

APIRule and Service Connection Issues

APIRule v2

Issues When Creating APIRule

401 Unauthorized or 403 Forbidden

APIRule v2alpha1

Issues When Creating APIRule

401 Unauthorized or 403 Forbidden

APIRule v1beta1

Issues When Creating APIRule

401 Unauthorized or 403 Forbidden

404 Not Found

500 Server Error

External DNS Management Errors

Connection Refused or Timeout

Couldn't Resolve Host

Resource Ignored by the Controller

APIRule v2 Introduction

Blocked In-Cluster Communication

Missing Rules in APIRule `v2alpha1`

Missing Rules in APIRule `v2`

Changed Status Schema in APIRule `v2`

SAP BTP Operator

Create the sap-btp-manager Secret

Install the SAP BTP Operator Module

Preconfigured Credentials and Access

Create Service Instances and Service Bindings

Update Service Instances

Delete Service Bindigs and Service Instances

Migrate Service Instances and Service Bindings from a Custom SAP BTP Service Operator

Working with Multiple Subaccounts

Instance-Level Mapping

Namespace-Level Mapping

Pass Parameters

Rotate Service Bindings

Formats of Service Binding Secrets

Resources

SAP BTP Operator Custom Resource

Service Instance Custom Resource

Service Binding Custom Resource

Tutorials

Create an SAP BTP Service in Your Kyma Cluster

Application Connector

Architecture

Technical Reference

Istio Gateway

Application Gateway

Application Connectivity Validator

Runtime Agent

UCL Connection

Configuring Runtime

Tutorials

Establish a Secure Connection with UCL

Maintain a Secure Connection with UCL

Revoke a Client Certificate (RA)

Configure Runtime Agent with UCL

Reconnect Runtime Agent with UCL

Resources

Application CR

Application Connector CR

CompassConnection CR

Tutorials

Integrate an External System with Kyma

Create an Application CR

Register a Service

Register a Secured API

Disable TLS Validation

Call a Registered External Service from Kyma

Cloud Manager

Cloud Manager Module

NFS

VPC Peering

Authorizing Cloud Manager in the Remote Cloud Provider

Redis

Resources

IpRange Custom Resource

AwsNfsVolume Custom Resource

AwsNfsVolumeBackup Custom Resource

AwsNfsBackupSchedule Custom Resource

AwsNfsVolumeRestore Custom Resource

GcpNfsVolume Custom Resource

GcpNfsVolumeBackup Custom Resource

GcpNfsBackupSchedule Custom Resource

GcpNfsVolumeRestore Custom Resource

AwsVpcPeering Custom Resource

GcpVpcPeering Custom Resource

AzureVpcPeering Custom Resource

AwsRedisInstance Custom Resource

GcpRedisInstance Custom Resource

AzureRedisInstance Custom Resource

AwsRedisCluster Custom Resource

GcpRedisCluster Custom Resource

GcpSubnet Custom Resource

AzureRedisCluster Custom Resource

Tutorials

Using NFS in Amazon Web Services

Using NFS in Google Cloud

Creating VPC Peering in Amazon Web Services

Creating VPC Peering in Google Cloud

Creating VPC Peering in Microsoft Azure

Using AwsRedisInstance Custom Resources

Using GcpRedisInstance Custom Resources

Using AzureRedisInstance Custom Resources

Using AwsRedisCluster Custom Resources

Using GcpRedisCluster Custom Resources

Using AzureRedisCluster Custom Resources

Glossary

Docker Registry

Module Configuration

Storage Configuration

Tutorials

Use Docker Registry Internally

Expose Docker Registry

Remove Image Manifest

Resources

Docker Registry Custom Resource

Eventing

Module Lifecycle

Configuration

Eventing Architecture

Event Names

Eventing Metrics

Tutorials

Create Subscription Subscribing to Multiple Event Types

Event Name Cleanup in Subscriptions

Changing Events Max-In-Flight in Subscriptions

Publish Legacy Events Using Kyma Eventing

Resources

Subscription CR

Troubleshooting

Kyma Eventing - Basic Diagnostics

NATS JetStream Backend Troubleshooting

Subscriber Receives Irrelevant Events

Eventing Backend Stopped Receiving Events Due To Full Storage

Published Events Are Pending in the Stream

Keda

Configuring Keda Module

Keda Module Footprint

KEDA Demo Application

Keda CR Conditions

NATS

Module Lifecycle

Module Configuration

Acquiring NATS Server System Account Credentials

Serverless

From Code to Function

Configuring Serverless

Development Toolkit

Function Security

Limitations

Tutorials

Create an Inline Function

Create a Git Function

Expose the Function

Manage Functions Through Kyma CLI

Send and Receive Cloud Events

Customize Function Traces

Override Runtime Image

Inject Environment Variables

Use External Scalers

Access to Secrets Mounted as Volume

Resources

Function CR

Serverless CR

Technical Reference

Buildless Serverless

Serverless Architecture

Internal Docker Registry

Environment Variables in Functions

Sample Functions

Function Processing

Git Source Type

Function's Specification

Available Presets

Serverless Buildless Mode

Troubleshooting Guides

Functions Won't Build

Container Fails

Functions Failing To Build on k3d

Serverless Periodically Restarting

Best Practices

Telemetry

Telemetry Pipeline API

Set Up the OTLP Input

Collecting Logs

Configure Application Logs

Configure Istio Access Logs

Collecting Traces

Configure Istio Tracing

Collecting Metrics

Collect Prometheus Metrics

Collect Istio Metrics

Collect Runtime Metrics

Filtering and Processing Data

Filter Logs

Filter Traces

Filter Metrics

Transformation to OTLP Logs

Automatic Data Enrichment

Integrate with your OTLP Backend

Migrate Your LogPipeline from HTTP to OTLP Logs

Monitor Pipeline Health

Troubleshooting the Telemetry Module

Architecture

Logs Architecture

Traces Architecture

Metrics Architecture

Istio Integration

Integration Guides

SAP Cloud Logging

Dynatrace

Prometheus

Loki

Jaeger

Amazon CloudWatch

OpenTelemetry Demo App

Sample App

Resources

Telemetry

LogPipeline

TracePipeline

MetricPipeline

Logs (Fluent Bit)

Registry Proxy

Registry Proxy Recommendations

Tutorials

Create Kyma Registry Proxy Connection and a Target Deployment

Resources

Connection CR

Registry Proxy CR

Technical Reference

Architecture

Community Modules

User Interfaces

Kyma Dashboard

Command Palette

Kyma CLI

Tutorials

Adding and Deleting a Kyma Module Using Kyma CLI

Setting Your Module to the Managed and Unmanaged State in Kyma CLI

Running an Application Using the `app push` Command

Commands

kyma

kyma alpha

kyma alpha authorize

kyma alpha diagnose

kyma alpha hana

kyma alpha hana map

kyma alpha kubeconfig

kyma alpha kubeconfig generate

kyma alpha provision

kyma alpha reference-instance

kyma app

kyma app push

kyma completion

kyma completion bash

kyma completion fish

kyma completion powershell

kyma completion zsh

kyma help

kyma module

kyma module add

kyma module catalog

kyma module delete

kyma module list

kyma module manage

kyma module pull

kyma module unmanage

kyma version

Operation Guides

Operations

Troubleshooting

Glossary

On this page

Technical Reference

In this section, you'll find the architecture documents.

Pager

Previous pageRegistry Proxy CR

Next pageArchitecture

Terms of Use | Privacy Statement | Legal Disclosure

Istio Service Mesh

Tutorials

Technical Reference

Troubleshooting

Tutorials

Expose a Workload

Use APIRule v2

Use APIRule v2alpha1

Use APIRule v1beta1

Expose and Secure a Workload

Use APIRule v2

Use APIRule v2alpha1

Use APIRule v1beta1

Security

Custom Resources

APIGateway Custom Resource

APIRule Custom Resource

v2

v2alpha1

v1beta1

APIRule Migration

Technical Reference

Troubleshooting Guides

APIRule and Service Connection Issues

APIRule v2

APIRule v2alpha1

APIRule v1beta1

External DNS Management Errors

APIRule v2 Introduction

Resources

Tutorials

Technical Reference

Runtime Agent

Tutorials

Resources

Tutorials

Register a Service

VPC Peering

Resources

Tutorials

Tutorials

Resources

Resources

Troubleshooting

Tutorials

Resources

Technical Reference

Troubleshooting Guides

Collecting Logs

Collecting Traces

Collecting Metrics

Filtering and Processing Data

Integrate with your OTLP Backend

Architecture

Integration Guides

Resources

Tutorials

Resources

Technical Reference

Tutorials

Commands

Technical Reference ​

Technical Reference