diff --git a/docs/01-overview/_sidebar.md b/docs/01-overview/_sidebar1.md similarity index 100% rename from docs/01-overview/_sidebar.md rename to docs/01-overview/_sidebar1.md diff --git a/docs/02-get-started/_sidebar.md b/docs/02-get-started/_sidebar1.md similarity index 100% rename from docs/02-get-started/_sidebar.md rename to docs/02-get-started/_sidebar1.md diff --git a/docs/03-tutorials/00-api-exposure/_sidebar.md b/docs/03-tutorials/00-api-exposure/_sidebar1.md similarity index 100% rename from docs/03-tutorials/00-api-exposure/_sidebar.md rename to docs/03-tutorials/00-api-exposure/_sidebar1.md diff --git a/docs/03-tutorials/00-application-connectivity/_sidebar.md b/docs/03-tutorials/00-application-connectivity/_sidebar1.md similarity index 100% rename from docs/03-tutorials/00-application-connectivity/_sidebar.md rename to docs/03-tutorials/00-application-connectivity/_sidebar1.md diff --git a/docs/03-tutorials/00-eventing/_sidebar.md b/docs/03-tutorials/00-eventing/_sidebar1.md similarity index 100% rename from docs/03-tutorials/00-eventing/_sidebar.md rename to docs/03-tutorials/00-eventing/_sidebar1.md diff --git a/docs/03-tutorials/00-security/_sidebar.md b/docs/03-tutorials/00-security/_sidebar1.md similarity index 100% rename from docs/03-tutorials/00-security/_sidebar.md rename to docs/03-tutorials/00-security/_sidebar1.md diff --git a/docs/03-tutorials/_sidebar.md b/docs/03-tutorials/_sidebar1.md similarity index 100% rename from docs/03-tutorials/_sidebar.md rename to docs/03-tutorials/_sidebar1.md diff --git a/docs/04-operation-guides/_sidebar.md b/docs/04-operation-guides/_sidebar1.md similarity index 100% rename from docs/04-operation-guides/_sidebar.md rename to docs/04-operation-guides/_sidebar1.md diff --git a/docs/04-operation-guides/operations/_sidebar.md b/docs/04-operation-guides/operations/_sidebar1.md similarity index 100% rename from docs/04-operation-guides/operations/_sidebar.md rename to docs/04-operation-guides/operations/_sidebar1.md diff --git a/docs/04-operation-guides/security/_sidebar.md b/docs/04-operation-guides/security/_sidebar1.md similarity index 100% rename from docs/04-operation-guides/security/_sidebar.md rename to docs/04-operation-guides/security/_sidebar1.md diff --git a/docs/04-operation-guides/troubleshooting/_sidebar.md b/docs/04-operation-guides/troubleshooting/_sidebar1.md similarity index 100% rename from docs/04-operation-guides/troubleshooting/_sidebar.md rename to docs/04-operation-guides/troubleshooting/_sidebar1.md diff --git a/docs/05-technical-reference/00-architecture/README.md b/docs/05-technical-reference/00-architecture/README.md index 9f7016852120..970f8fd941ea 100644 --- a/docs/05-technical-reference/00-architecture/README.md +++ b/docs/05-technical-reference/00-architecture/README.md @@ -11,4 +11,3 @@ In this section you can learn more about technicalities behind each main area: t ### Eventing * [Eventing Architecture](evnt-01-architecture.md) - diff --git a/docs/05-technical-reference/00-architecture/_sidebar.md b/docs/05-technical-reference/00-architecture/_sidebar1.md similarity index 100% rename from docs/05-technical-reference/00-architecture/_sidebar.md rename to docs/05-technical-reference/00-architecture/_sidebar1.md diff --git a/docs/05-technical-reference/00-configuration-parameters/_sidebar.md b/docs/05-technical-reference/00-configuration-parameters/_sidebar1.md similarity index 100% rename from docs/05-technical-reference/00-configuration-parameters/_sidebar.md rename to docs/05-technical-reference/00-configuration-parameters/_sidebar1.md diff --git a/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md b/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md index 5522a1f9727b..f29ba0bd7a24 100644 --- a/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md +++ b/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md @@ -1,5 +1,5 @@ --- -title: Connection with Compass +title: Runtime Agent Connection with Compass --- Runtime Agent connects to Compass using a one-time token from the Connector and exchanges it for a certificate, which is later used to fetch Applications from the Director. diff --git a/docs/05-technical-reference/00-custom-resources/_sidebar.md b/docs/05-technical-reference/00-custom-resources/_sidebar1.md similarity index 100% rename from docs/05-technical-reference/00-custom-resources/_sidebar.md rename to docs/05-technical-reference/00-custom-resources/_sidebar1.md diff --git a/docs/05-technical-reference/00-custom-resources/ac-01-application.md b/docs/05-technical-reference/00-custom-resources/ac-01-application.md index 5b28044e8c28..aca58a800d5b 100644 --- a/docs/05-technical-reference/00-custom-resources/ac-01-application.md +++ b/docs/05-technical-reference/00-custom-resources/ac-01-application.md @@ -1,5 +1,5 @@ --- -title: Application +title: Application CR --- The `applications.applicationconnector.kyma-project.io` CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format used to register an Application in Kyma. The `Application` custom resource (CR) defines the APIs that the Application offers. To get the up-to-date CRD and show the output in the YAML format, run this command: diff --git a/docs/05-technical-reference/00-custom-resources/evnt-01-subscription.md b/docs/05-technical-reference/00-custom-resources/evnt-01-subscription.md index 375a133f0b45..20be03e315db 100644 --- a/docs/05-technical-reference/00-custom-resources/evnt-01-subscription.md +++ b/docs/05-technical-reference/00-custom-resources/evnt-01-subscription.md @@ -1,5 +1,5 @@ --- -title: Subscription +title: Subscription CR --- The `subscriptions.eventing.kyma-project.io` CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format used to subscribe to events. To get the up-to-date CRD and show the output in the YAML format, run this command: diff --git a/docs/05-technical-reference/00-custom-resources/evnt-02-eventingbackend.md b/docs/05-technical-reference/00-custom-resources/evnt-02-eventingbackend.md index 8bf38841a5ff..da00691b7262 100644 --- a/docs/05-technical-reference/00-custom-resources/evnt-02-eventingbackend.md +++ b/docs/05-technical-reference/00-custom-resources/evnt-02-eventingbackend.md @@ -1,5 +1,5 @@ --- -title: EventingBackend +title: EventingBackend CR --- The `eventingbackends.eventing.kyma-project.io` CustomResourceDefinition (CRD) is a detailed description of the kind of data used to manage Eventing backends within Kyma. To get the up-to-date CRD and show the output in the YAML format, run this command: diff --git a/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md b/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md index f30e13d53b25..255d08dc5684 100644 --- a/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md +++ b/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md @@ -1,5 +1,5 @@ --- -title: Compass Connection +title: CompassConnection CR --- The `compassconnections.compass.kyma-project.io` CustomResourceDefinition (CRD) diff --git a/docs/05-technical-reference/_sidebar.md b/docs/05-technical-reference/_sidebar1.md similarity index 100% rename from docs/05-technical-reference/_sidebar.md rename to docs/05-technical-reference/_sidebar1.md diff --git a/docs/06-modules/README.md b/docs/06-modules/README.md index 7598c2386e4b..646c9a78b2d8 100644 --- a/docs/06-modules/README.md +++ b/docs/06-modules/README.md @@ -1,4 +1,4 @@ -## Kyma modules +# Kyma modules Classic Kyma offered a fixed set of preconfigured components whose development rhythm is synchronized and determined by the release schedule. diff --git a/docs/README.md b/docs/README.md index c814af17662e..ed32a0571597 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -## What is Kyma +# What is Kyma Kyma is an opinionated set of Kubernetes-based modular building blocks, including all necessary capabilities to develop and run enterprise-grade cloud-native applications. It is the open path to the SAP ecosystem supporting business scenarios end-to-end. @@ -7,7 +7,7 @@ It is the open path to the SAP ecosystem supporting business scenarios end-to-en Kyma is an actively maintained open-source project supported by SAP. The Kyma project is also a foundation of SAP BTP, Kyma runtime which is a part of SAP Business Technology Platform (BTP). You can use Kyma modules in your own Kubernetes cluster, or try the managed version from SAP BTP with a ready-to-use Kubernetes cluster powered by Gardener. -## Kyma's strengths +# Kyma's strengths Kyma is built upon leading cloud-native, open-source projects and open standards, such as Istio, NATS, Cloud Events, and Open Telemetry. We created an opinionated set of modules you can easily enable in your Kubernetes cluster to speed up cloud application development and operations. With Kyma, you save the time to pick the right tools and the effort to keep them secure and up to date. Also, you can use the modules you need from Kyma and complement them with other Kubernetes tools. @@ -15,6 +15,6 @@ Kyma is a Kubernetes-based application runtime with several extensions, not a fu Kyma has been open-source since 2018 and part of SAP BTP since 2019. We believe that openness and vendor independence is a valuable proposition. Even though Kyma is a part of the commercial product, SAP BTP, Kyma runtime, it will remain an open project. We also believe that offering an open-source project as a commercial product only benefits both parties. Open-source users get the confidence that the project won't be abandoned anytime soon, and customers see the quality and technical details of the product. Apart from that, SAP strongly supports the open-source community. For more information, visit [SAP Open Source](https://community.sap.com/topics/open-source). -## Kyma and SAP BTP, Kyma runtime +# Kyma and SAP BTP, Kyma runtime There's a difference between the open-source Kyma project and SAP BTP, Kyma runtime. The latter one is a bundle of a Kubernetes cluster powered by Gardener and Kyma modules provided as a managed service. All the components are regularly updated, and the availability is monitored and guaranteed by Service-Level Agreement (SLA). Kyma runtime is also preconfigured to easily connect to other SAP services and systems. Using Kyma runtime, you can face some limitations in configuring Kyma components because some settings are managed centrally and overwrite user changes. But still, you get the admin access to the cluster, that is, the **cluster-admin** role. If you use Kyma open-source components, you have more control and flexibility over installation, configuration, and upgrade processes but more operations-related responsibilities. diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 8f8643e3082b..bb899b05b7e0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,11 +1,66 @@ * [Home](/README.md) * [Kyma Components](/01-overview/README.md) + * [API Exposure](/01-overview/api-exposure/README.md) + * [Eventing](/01-overview/eventing/README.md) + * [Istio](/istio/user/00-overview/README.md) + * [Service Management](/01-overview/service-management/README.md) + * [User Interfaces](/01-overview/ui/README.md) * [Get Started](/02-get-started/README.md) + * [Kyma quick install](01-quick-install.md) + * [Deploy and expose a Function](02-deploy-expose-function.md) + * [Deploy and expose a microservice](03-deploy-expose-microservice.md) + * [Trigger a workload with an event](04-trigger-workload-with-event.md) * [Developer Tutorials](/03-tutorials/README.md) + * [API Exposure](/03-tutorials/00-api-exposure/README.md) + * [Create a workload](/03-tutorials/00-api-exposure/apix-01-create-workload.md) + * [Set up a custom domain](/03-tutorials/00-api-exposure/apix-02-setup-custom-domain-for-workload.md) + * [Set up a TLS Gateway](/03-tutorials/00-api-exposure/apix-03-set-up-tls-gateway.md) + * [Expose a workload](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-01-expose-workload-apigateway.md) + * [Expose multiple workloads](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-02-expose-multiple-workloads.md) + * [Expose workloads in multiple Namespaces](/03-tutorials/00-api-exposure/apix-04-expose-workload/apix-04-03-expose-workloads-multiple-namespaces.md) + * [Secure workload with OAuth 2](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-01-expose-and-secure-workload-oauth2.md) + * [Get a JSON Web Token (JWT)](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-02-get-jwt.md) + * [Secure a workload with JWT](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-03-expose-and-secure-workload-jwt.md) + * [Secure a workload with Istio](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-04-expose-and-secure-workload-istio.md) + * [Secure a workload with a certificate](/03-tutorials/00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-05-expose-and-secure-workload-with-certificate.md) + * [Application Connectivity](/03-tutorials/00-application-connectivity/README.md) + * [Establish a secure connection with Compass](ra-01-establish-secure-connection-with-compass.md) + * [Maintain a secure connection with Compass](ra-02-maintain-secure-connection-with-compass.md) + * [Revoke a client certificate (RA)](ra-03-revoke-client-certificate.md) + * [Configure Runtime Agent with Compass](ra-04-configure-runtime-agent-with-compass.md) + * [Reconnect Runtime Agent with Compass](ra-05-reconnect-runtime-agent-with-compass.md) + * [Eventing](/03-tutorials/00-eventing/README.md) + * [Create Subscription subscribing to multiple event types](evnt-02-subs-with-multiple-filters.md) + * [Event name cleanup in Subscriptions](evnt-03-type-cleanup.md) + * [Changing Events Max-In-Flight in Subscriptions](evnt-04-change-max-in-flight-in-sub.md) + * [Publish legacy events using Kyma Eventing](evnt-05-send-legacy-events.md) + * [Observability](/03-tutorials/00-observability.md) + * [Security](/03-tutorials/00-security/README.md) + * [Set up or update a custom domain TLS certificate in Kyma](sec-01-tls-certificates-security.md) + * [Prepare self-signed root CA and client certificates](sec-02-mtls-selfsign-client-certicate.md) + * [Set up a custom identity provider](sec-03-set-up-idp.md) + * [Service Management](/03-tutorials/00-service-management/smgt-01-deploy-service.md) * [Operation Guides](/04-operation-guides/README.md) -* [Technical Reference](05-technical-reference/README.md) -* [Kyma Modules](06-modules/README.md) + * [Operations](/04-operation-guides/operations/README.md) + * [Security](/04-operation-guides/security/README.md) + * [Troubleshooting](/04-operation-guides/troubleshooting/README.md) +* [Technical Reference](/05-technical-reference/README.md) + * [API Overview](/05-technical-reference/00-api-overview/README.md) + * [Runtime Agent Architecture](/05-technical-reference/00-architecture/ra-01-runtime-agent-workflow.md) + * [Eventing Architecture](/05-technical-reference/00-architecture/evnt-01-architecture.md) + * [CLI Commands](/05-technical-reference/00-cli-commands/README.md) + * [Runtime Agent Connection with Compass](/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md) + * [Application CR](/05-technical-reference/00-custom-resources/ac-01-application.md) + * [CompassConnection CR](/05-technical-reference/00-custom-resources/ra-01-compassconnection.md) + * [Subscription CR](/05-technical-reference/00-custom-resources/evnt-01-subscription.md) + * [EventingBackend CR](/05-technical-reference/00-custom-resources/evnt-02-eventingbackend.md) + * [Configure Authorization (OAuth2, JWT)](/05-technical-reference/apix-01-config-authorizations-apigateway.md) + * [Allowed domains in API Gateway Controller](/05-technical-reference/apix-02-whitelisted-domains.md) + * [Blocked services in API Gateway Controller](/05-technical-reference/apix-03-blacklisted-services.md) + * [Configure the runtime](/05-technical-reference/ra-01-configuring-runtime.md) + * [Event names](/05-technical-reference/evnt-01-event-names.md) +* [Kyma Modules](/06-modules/README.md) * [SAP BTP Operator](/btp-manager/user/README.md) * [Application Connector](/application-connector-manager/user/README.md) * [Keda](/keda-manager/user/README.md) diff --git a/docs/assets/logo_icon.svg b/docs/assets/logo_icon.svg new file mode 100644 index 000000000000..9b0d3cdb0c66 --- /dev/null +++ b/docs/assets/logo_icon.svg @@ -0,0 +1,13 @@ + + + logo_icon + + + + + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1abf56210de7..4f483f309262 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,15 +22,16 @@
+