Version:
preview (latest)
Overview
Main areas
API Exposure
API Gateway
Useful links
Application Connectivity
Application Connector
Application Gateway
Security
Application Connectivity - useful links
Runtime Agent
Runtime Agent - useful links
Eventing
Glossary
Useful links
Observability
Monitoring
Logging
Tracing
Telemetry
Observability - Useful links
Serverless
Serverless
From code to Function
Container registries
Development toolkit
Useful links
Security considerations
Service Management
What is Service Management in Kyma?
Service Management - useful links
Service Mesh
Details
Default Istio setup in Kyma
Istio sidecars in Kyma and why you want them
Useful links
Telemetry
Telemetry Operator
Application Logs
Traces
Tutorials
User Interfaces
Kyma Dashboard
Kyma CLI
Get Started
Quick install
Deploy and expose a Function
Deploy and expose a microservice
Trigger a workload with an event
Observability
Developer Tutorials
API Exposure
Create a workload
Set up a custom domain for a workload
Expose a workload
Expose multiple workloads on the same host
Expose and secure a workload with OAuth2
Get a JSON Web Token (JWT)
Expose and secure a workload with Istio
Expose and secure a workload with JWT
Expose workloads in multiple Namespaces with a single APIRule definition
Expose and secure a workload with a certificate
Application Connectivity
Create a new Application
Register a service
Register a secured API
Call a registered external service from Kyma
Disable TLS certificate verification
Establish a secure connection with Compass
Maintain a secure connection with Compass
Revoke a client certificate (RA)
Configure Runtime Agent with Compass
Reconnect Runtime Agent with Compass
Eventing
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
Observability
Security
Set up your custom domain TLS certificate
Prepare self-signed root CA and client certificates
Set up a mutual TLS Gateway
Set up a custom identity provider
Serverless
Create an inline Function
Create a Git Function
Expose a Function with an API Rule
Manage Functions with Kyma CLI
Debug a Function
Synchronize Git resources with the cluster using a GitOps operator
Set an external Docker registry
Switch to an external Docker registry at runtime
Log into a private package registry using credentials from a Secret
Set asynchronous communication between Functions
Customize Function traces
Override runtime image
Inject environment variables
Use external scalers
Access to Secrets mounted as Volume
Service Management
Deploy an SAP BTP service in your Kyma cluster
Operation Guides
Operations
Install Kyma CLI
Install Kyma
Change Kyma settings
Upgrade or Downgrade Kyma
Uninstall Kyma or components
Back up Kyma
Pass an access token in a request header
Grafana Dashboards for Kyma Eventing
Kyma Eventing Metrics
Acquiring NATS server system account credentials
Access Kyma application logs
Adjust Loki log limits
Enable Grafana for Istio monitoring
Enable Istio access logs
Enable mTLS for custom metrics
Enable Kyma with Runtime Agent
Enable automatic Istio sidecar proxy injection
Security
Authentication in Kyma
Authorization in Kyma
Access Kyma securely
Ingress and Egress traffic
OAuth2 server customization and operations
Access and Expose Grafana and Jaeger
Access and Expose Kiali, Grafana, and Jaeger
Useful links
Troubleshooting
Component doesn't work after successful installation
Local Kyma deployment fails with pending Pods
Provisioning k3d fails on a Linux machine
Error for kubectl port forwarding
Kyma domain is not resolvable
Kyma resource is misconfigured
Cannot create a volume snapshot
API Exposure
Cannot connect to a service exposed by an API Rule - basic diagnostics
Cannot connect to a service exposed by an API Rule - 401 Unauthorized or 403 Forbidden
Cannot connect to a service exposed by an API Rule - 404 Not Found
External DNS management - connection refused or timeout
External DNS management - could not resolve host
External DNS management - resource ignored by the controller
Certificate management - Issuer not created
Kyma Gateway - not reachable
Pods stuck in `Pending/Failed/Unknown` state after upgrade
Issues when creating an APIRule - Various reasons
Eventing
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
Observability
Prometheus Istio Server restarting or in crashback loop
Jaeger doesn't show the traces you want to see
Loki doesn't show the logs you want to see
Security
Issues with certificates on Gardener
No access to OAuth2 protected API Rules
Serverless
Failure to build Functions
Failing Function container
Function debugger stops at dependency files
Functions failing to build on k3d
Serverless periodically restarting
Service Mesh
Can't access a Kyma endpoint (503 status code)
Connection refused errors
Issues with Istio sidecar injection
Incompatible Istio sidecar version after Kyma upgrade
Technical Reference
Architecture
Application Connector components
Application Gateway
API Gateway Architecture
Eventing Architecture
Monitoring Architecture
Logging Architecture
Tracing Architecture
Runtime Agent Architecture
Serverless Architecture
Configuration parameters
Application Connector chart
ORY chart
Observability charts
Connection with Compass
Cluster Users chart
Istio chart
Istio Resources chart
Serverless chart
Environment variables
Custom resources
Application
API Rule
Subscription
EventingBackend
Istio
Compass Connection
Function
Git Repository
Telemetry - LogPipeline
Telemetry - LogParser
Telemetry - TracePipeline
Application Gateway details
Configure Authorization (OAuth2, JWT)
Allowed domains in API Gateway Controller
Blocked services in API Gateway Controller
Event names
Configuring the Runtime
Sample Functions
Function processing stages
Switching registries at runtime
Git source type
Exposing Functions
Function configuration file
Supported webhooks
Function's specification
Available presets
Glossary
Migration Guide 2.10-2.11
Migration Guide 2.9-2.10
Debug a Function
This tutorial shows how to use an external IDE to debug a Function in Kyma CLI.
Steps
Follows these steps:
Visual Studio Code
GoLand
Steps