Overview

Kyma is a cloud-native application development framework.

It provides the last mile capabilities that a developer needs to build a cloud-native application using several open-source projects under the Cloud Native Computing Foundation (CNCF), such as Kubernetes, Istio, NATS, Kubeless, and Prometheus, to name a few. It is designed natively on Kubernetes and, therefore, it is portable to all major cloud providers.

Kyma allows you to connect and extend products in a quick and modern way, using serverless computing and microservice architecture.

The extensions and customizations you create are decoupled from the core applications, which means that:

• deployments are quick
• scaling is independent from the core applications
• the changes you make can be easily reverted without causing downtime of the production system

Living outside of the core product, Kyma allows you to be completely language-agnostic and customize your solution using the technology stack you want to use, not the one the core product dictates. Additionally, Kyma follows the "batteries included" principle and comes with all of the "plumbing code" ready to use, allowing you to focus entirely on writing the domain code and business logic.

Read the documentation to learn about the product, its technology stack, and components.

Installation

Install Kyma locally and on a cluster.

Usage

Kyma comes with the ready-to-use code snippets that you can use to test the extensions and the core functionality. See the list of existing examples in the examples repository.

Development

Develop on your remote repository forked from the original repository in Go. See the example that uses the ui-api-layer project located in the components directory in the kyma repository but applies to any Go project. This set of instructions uses the recommended git workflow and the general contribution flow. Read also the [CONTRIBUTING.md] document that includes the contributing rules specific for this repository.

Follow these steps:

NOTE: The example assumes you have the $GOPATH already set.

1. Fork the repository in GitHub.

2. Clone the fork to your $GOPATH workspace. Use this command to create the folder structure and clone the repository under the correct location:

git clone git@github.com:{GitHubUsername}/kyma.git $GOPATH/src/github.com/kyma-project/kyma

Follow the steps described in the git-workflow.md document to configure your fork.

3. Install dependencies.

Go to the main directory of the project in your workspace location and install the required dependencies:

$ cd components/ui-api-layer
$ dep ensure -vendor-only

4. Build the project.

Every project runs differently. Follow instructions in the main README.md document of the given project to build it.

5. Create a branch and start to develop.

Do not forget about creating unit and acceptance tests if needed. For the unit tests, follow the instructions specified in the main README.md document of the given project. For the details concerning the acceptance tests, go to the corresponding directory inside the tests directory. Find the information on how to run changes on the cluster without a Docker image in the Develop a service locally without using Docker document.

NOTE: For more details about testing, go to the Testing Kyma document.

6. Test your changes.

Project structure

The repository has the following structure:

  ├── .github                     # Pull request and issue templates             
  ├── components                  # Source code of all Kyma components                                                
  ├── docs                        # Documentation source files
  ├── installation                # Installation scripts     
  ├── resources                   # Helm charts and Kubernetes resources for the Kyma installation
  ├── tests                       # Acceptance tests
  └── tools                       # Source code of utilities used, for example, for the installation and testing