From e76ec4cf746cd4c8844451f46e68d93a2a7163fe Mon Sep 17 00:00:00 2001 From: mmitoraj Date: Wed, 10 Jan 2024 16:02:22 +0100 Subject: [PATCH 1/2] Update main Kyma README --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 27f68ccdbee0..038b0699d84a 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,14 @@ ## Overview -**Kyma** `/kee-ma/` is an application runtime that provides you a flexible and easy way to connect, extend, and customize your applications in the cloud-native world of Kubernetes. +**Kyma** `/kee-ma/` 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. -Out of the box, Kyma offers various functionalities, such as: +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 modules offer various functionalities, such as: - [Serverless](https://kyma-project.io/#/serverless-manager/user/README) development platform to run lightweight Functions in a cost-efficient and scalable way -- [System connectivity](https://kyma-project.io/#/01-overview/application-connectivity/README) that provides endpoint to securely register Events and APIs of external applications +- [System connectivity](https://kyma-project.io/#/application-connector-manager/user/README) that provides an endpoint to securely register Events and APIs of external applications - [Istio](https://kyma-project.io/#/istio/user/README) for service-to-service communication and proxying - [Service Management](https://kyma-project.io/#/01-overview/service-management/README) to use the built-in cloud services from such cloud providers as GCP, Azure, and AWS - Secure API exposure @@ -27,21 +29,19 @@ Out of the box, Kyma offers various functionalities, such as:

-Go to the [Kyma project website](https://kyma-project.io/) to learn more about our project, its features, and components. +Go to the [Kyma project website](https://kyma-project.io/) to learn more about our project, its features, and Kyma modules. ## Installation -Install Kyma locally or on a cluster. See the [Installation guides](https://kyma-project.io/#/04-operation-guides/operations/02-install-kyma) for details. - -> **NOTE:** Make sure to install the latest Kyma version and keep it up to date by [upgrading Kyma](https://kyma-project.io/#/04-operation-guides/operations/05-upgrade-kyma). +To get started with Kyma and install it with specific modules, see the [Quick Install](https://kyma-project.io/#/02-get-started/01-quick-install) guide. ## 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`](https://github.com/kyma-project/examples) repository. +Kyma comes with 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`](https://github.com/kyma-project/examples) repository. ## Contributing -Read the [`CONTRIBUTING.md`](CONTRIBUTING.md) document that includes the contributing rules and development steps specific for this repository. +Read the [`CONTRIBUTING.md`](CONTRIBUTING.md) document that includes the contributing rules and development steps specific to this repository. ## Kyma Users From 9ef4e240bc50b7cb5f076511c98754b4e3008b45 Mon Sep 17 00:00:00 2001 From: mmitoraj Date: Fri, 12 Jan 2024 09:45:45 +0100 Subject: [PATCH 2/2] Reduced Join Us section --- README.md | 85 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 038b0699d84a..a9b0d0e1bec1 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ Kyma modules offer various functionalities, such as: - [Serverless](https://kyma-project.io/#/serverless-manager/user/README) development platform to run lightweight Functions in a cost-efficient and scalable way - [System connectivity](https://kyma-project.io/#/application-connector-manager/user/README) that provides an endpoint to securely register Events and APIs of external applications - [Istio](https://kyma-project.io/#/istio/user/README) for service-to-service communication and proxying -- [Service Management](https://kyma-project.io/#/01-overview/service-management/README) to use the built-in cloud services from such cloud providers as GCP, Azure, and AWS -- Secure API exposure +- [Service Management](https://kyma-project.io/#/btp-manager/user/README) to use the built-in cloud services from such cloud providers as GCP, Azure, and AWS +- Secure [API exposure](https://kyma-project.io/#/api-gateway/user/README) - Collection and shipment of telemetry data to observability backends using the [Telemetry module](https://kyma-project.io/#/telemetry-manager/user/README) - CLI supported by the intuitive UI through which you can connect your application to a Kubernetes cluster @@ -66,87 +66,6 @@ The following 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](https://shipit.dev/posts/kubernetes-overview-diagrams.html) and basic concepts such as: namespace, Pod, Deployment, Secret, ConfigMap, ReplicaSet, Service, CustomResourceDefinition, 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](https://github.com/K8sAcademy/Fundamentals-HandsOn) 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](https://kyma-project.io/) -- [Getting Started guide](https://kyma-project.io/#/02-get-started/README) -- Kyma project [Youtube channel](https://www.youtube.com/watch?v=wqQflgmyboY&list=PLmZLSvJAm8FabPF4hLjScx-dDl84NK3l5) - -### Open Job Positions - Kyma team is located mostly in Poland and Germany. See the open job positions for both locations: - [Gliwice, Poland](https://jobs.sap.com/search/?createNewAlert=false&q=%23kymaopensource&optionsFacetsDD_department=&optionsFacetsDD_customfield3=&optionsFacetsDD_country=&locationsearch=) - [Munich, Germany](https://jobs.sap.com/search/?createNewAlert=false&q=%23kyma&optionsFacetsDD_department=&optionsFacetsDD_customfield3=&optionsFacetsDD_country=&locationsearch=munich)