kyma

README

Overview

Kyma /kee-ma/ is a platform for extending applications with microservices and serverless Functions. It provides CLI and UI through which you can connect your application to a Kubernetes cluster. You can also expose the application's API or events securely thanks to the built-in Application Connector. You can then implement the business logic you require by creating microservices or serverless Functions. Trigger them to react to particular events or calls to your application's API.

To limit the time spent on coding, use the built-in cloud services from Service Management from such cloud providers as GCP, Azure, and AWS.

Go to the Kyma project website to learn more about our project, its features, and components.

Installation

Install Kyma locally or on a cluster. See the Installation guides for details.

NOTE: Make sure to install the latest Kyma version and keep it up to date by upgrading Kyma.

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. 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. Build the project.

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

4. 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.

5. Test your changes.

Kyma users

Read how these companies use Kyma:

Join us

If you would like to join us and work together on the Kyma project, there are some prerequisite skills you should acquire beforehand. Git basic skills are the most important for a quick start with the code. Mastering Kubernetes skills is very important for your future work.

Required programming skills

• Git basic skillset:

  • Forking a project from the main repository to your own repository
  • Checking out code from a public and private repository
  • Managing and fetching remote repositories
  • Creating a custom branch, adding and pushing commits to a remote branch of a forked project
  • Rebasing and merging a local branch with changes to the main branch
  • Creating and merging pull requests to the main branch
  • Interpreting automatic test results, rerunning a test suite
  • Resolving conflicts with the main branch

• Go basic skillset:

  • Installing and upgrading Go compiler
  • Setting up your IDE
  • Building a GoLang project
  • Running tests on a Golang project
  • Running code in the debug mode in your IDE
  • Understanding Makefiles and Dockerfiles
  • Downloading dependencies for the project
  • Understanding dependency tools such as go mod and dep
  • Downloading additional tools modules with the go get command

• Kubernetes basic skillset:

  • Understanding basic Kubernetes architecture and basic concepts such as: Namespace, Pod, Deployment, Secret, Config Map, Replica Set, Service, Custom Resource Definition, Kubernetes Control Loop; understanding Kubernetes Design Patterns such as sidecars and init containers
  • Using a kubeconfig file to connect to a cluster
  • Browsing cluster resources using kubectl commands and editing Kubernetes resources using Terminal
  • Applying YAML files to a cluster with Kubernetes resources
  • Port forwarding from a running Pod to a local machine
  • Installing and using Minikube
  • Displaying logs from a container
  • Exporting Kubernetes objects to YAML files
  • Understanding Helm package manager
  • Certified Kubernetes Application Developer (CKAD) level preferred

• Docker basic skillset:

  • Listing all running Docker containers
  • Starting, stopping, deleting Docker containers
  • Exposing ports from running containers
  • Managing local image repositories
  • Pulling images from a remote repository and running them
  • Building images and tagging them
  • Pushing and managing images in your Docker Hub account
  • Executing bash commands inside containers

TIP: Complete the Docker and Kubernetes fundamentals training to get the basic Docker and Kubernetes knowledge.

• Cloud services skillset:

  • Logging in to Google Cloud Platform (GCP)
  • Understanding GCP basics concepts
  • Creating and deleting Kubernetes clusters in team projects on GCP
  • Creating Kubernetes shoot clusters on GCP and Azure

• Linux/Terminal basic skill set

  • Understanding basic bash scripting
  • Understanding the basics of the Unix filesystem
  • Performing basic operations on files (list, create, copy, delete, move, execute)
  • Sending REST queries with curl or HTTPie
  • CLI/Terminal confident use

• Fluency with command-line JSON and YAML processors, such as jq, yq, grep

• CI/CD experience (ideally Prow)

• Other skills

  • Understanding the Architecture Base Pattern
  • Understanding the Service Mesh concept
  • Basic Markdown editing

Basic Kyma knowledge

These are the sources you can get the basic Kyma knowledge from:

• Official Kyma documentation
• Getting Started guide
• Kyma project Youtube channel

Open job positions

Kyma team is located mostly in Poland and Germany. See the open job positions for both locations:

• Gliwice, Poland
• Munich, Germany

FAQ

• What is your IDE?

  Nothing is enforced. People often use GoLand, Visual Studio Code, VIM.

• How do you approach testing in Go? Do you use any frameworks?

  We use tools such as classical Go runner, Gomega, Testify.

• How to learn Go?

  Here are some useful sources to learn Go:

  • Official Go learning tutorials
  • 50 Shades of Go: Traps, Gotchas, and Common Mistakes for New Golang Devs
  • Language converter - this tool helps you to convert code from one language to any other one