Merge pull request #134 from soda-cdm/development

Bumping master branch for v1.0.0 release

.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Build
+on: [push, pull_request_target, workflow_dispatch]
+jobs:
+  GO_CI:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '>=1.17.19'   
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}

.gitignore

@@ -13,3 +13,4 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+_output/

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# How to Contribute?
+
+1. Pick an [issue](https://github.com/soda-cdm/kahu/issues) to work on. For first-time contributors, the best would be to pick an issue [tagged good-first-issue](https://github.com/soda-cdm/kahu/labels/good%20first%20issue).
+
+2. If you feel adventurous and would like to take a challenging issue, we would love to have you contribute on issues [tagged help-wanted](https://github.com/soda-cdm/kahu/labels/help%20wanted).
+
+3. There is a [Contribution Guide](docs/contribution-guide.md) that explains how to create a fork and raise PR on GitHub.
+
+4. If the issue involves code changes you need to install development env using this [Development Guide](docs/development-guide.md).
+
+# Scope of Contribution
+
+Contributions are not necessarily in the form of code changes. SODA community can benefit from contributions such as:
+
+1. Blogs
+
+   a. Explain The use of Kahu's features
+
+   b. Describe How to use Kahu for data protection. Please do not shy away from getting as technical as you can.
+
+   c. Put your topic of interest
+
+2. Feedback to the community
+
+   Just helping advance any discussion on Soda Slack, Community meetings, office hours will make a big difference.
+
+3. Talking about Kahu in meetups
+
+   We would certainly encourage users or devs of Kahu to talk about it in open/closed forums. The community can help with logistics such as compiling/feedback on slide-decks, technical diagrams, etc.

Dockerfile

@@ -0,0 +1,21 @@
+# Copyright 2022 The SODA Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Dockerfile used for the building images.
+
+ARG BINARY
+
+FROM gcr.io/distroless/base-debian11:nonroot
+
+LABEL maintainer="SODA Developer <soda-developer@soda.io>"
+
+COPY ${BINARY} /usr/local/bin/${BINARY}

Makefile

@@ -0,0 +1 @@
+build/Makefile

Makefile.generate_proto

@@ -0,0 +1 @@
+build/Makefile.generate_proto

README.md

@@ -1 +1,27 @@
-# kahu
+# Kahu - The SODA container data backup and restore project
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Build Status](https://github.com/soda-cdm/kahu/actions/workflows/main.yml/badge.svg)](https://github.com/soda-cdm/kahu/actions/workflows/main.yml/)
+
+Kahu is part of SODA Container Data Management(CDM). Kahu provides seamless backup/restore for Kubernetes resources and data.
+
+
+## High Level Architecture
+![Kahu High Level Design](https://github.com/soda-cdm/documentation/blob/main/kahu/resources/Level_0_Arch.png)
+
+For more details, please refer [Design Doc](https://github.com/soda-cdm/documentation/blob/main/kahu/design_spec.md)
+
+
+## Getting Started
+
+Please take a look at the following documents to get started
+1. [Contribution Guide](https://github.com/soda-cdm/kahu/blob/development/docs/contribution-guide.md)
+2. [Deployment Guide](https://github.com/soda-cdm/documentation/blob/main/kahu/deployment_guide.md)
+3. [User Guide](https://github.com/soda-cdm/documentation/blob/main/kahu/user_guide.md)
+4. [API Reference](https://soda-cdm.github.io/kahu/)
+5. [Development Guide](https://github.com/soda-cdm/documentation/blob/main/kahu/development_guide.md)
+
+## Community
+ Please join [SODA Slack](https://sodafoundation.io/slack) and channel #soda-cdm.
+
+ For new contributor general information and help, please refer [New Contributor Starter Guides and Links](http://bit.ly/soda-starter)
+