Skip to content

Commit

Permalink
Merge pull request #6 from ggtakec/update_doc
Browse files Browse the repository at this point in the history
Updated README.md for launch K2HDKC DBaaS K8S CLI
  • Loading branch information
ggtakec authored Sep 30, 2021
2 parents 7270cec + 267ffd1 commit 40c8ed0
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,25 @@ K2HDKC DBaaS Command Line Interface(K2HR3 CLI Plugin)

## **K2HDKC DBaaS CLI(Command Line Interface)** - (K2HR3 CLI Plugin)
The **K2HDKC DBaaS CLI** (Command Line Interface of Database as a Service for K2HDKC) acts as a one of Plugin for the [K2HR3 CLI(Command Line Interface)](https://k2hr3.antpick.ax/).
This **K2HDKC DBaaS CLI** is included as one command `database` in the K2HR3 CLI, allowing you to build a K2HDKC cluster.
This **K2HDKC DBaaS CLI** is included as one command `database` in the K2HR3 CLI, allowing you to build a K2HDKC cluster in [OpenStack](https://www.openstack.org/) virtual machine.

![K2HDKC DBaaS](https://dbaas.k2hdkc.antpick.ax/images/top_k2hdkc_dbaas.png)

## K2HKDC DBaaS system Overview
K2HDKC DBaaS provides its functionality through Trove as a panel(feature) of OpenStack.
## About K2HKDC DBaaS
**K2HDKC DBaaS** (Database as a Service for K2HDKC) is a **Database as a Service** that uses [K2HR3](https://k2hr3.antpick.ax/) and works with [OpenStack](https://www.openstack.org/) and [kubernetes](https://kubernetes.io/) to build a [K2HDKC(K2Hash based Distributed Kvs Cluster)](https://k2hdkc.antpick.ax/index.html) Cluster for distributed KVS.
**K2HDKC DBaaS** (Database as a Service for K2HDKC) provides the following **two ways** to build **DBaaS(Database as a Service)** on [OpenStack](https://www.openstack.org/).
And provides **one way** to build **DBaaS(Database as a Service)** on [kubernetes](https://kubernetes.io/).

This repository is a tool that provides a Command Line Interface for building **K2HKDC DBaaS** cluster on [OpenStack](https://www.openstack.org/) virtual machines.
For other type's source code, see the repository below.

## About K2HKDC DBaaS system
This **K2HDKC DBaaS CLI** works in conjunction with [OpenStack](https://www.openstack.org/) system.
And the [K2HR3](https://k2hr3.antpick.ax/) system is used as the back end as an RBAC(Role Base Access Control) system dedicated to K2HDKC DBaaS.
Normally, users do not need to use the K2HR3 system directly, and the function as DBaaS uses Trove Dashboard(or Trove CLI).

The overall system overview diagram is shown below.
![K2HDKC DBaaS system](https://dbaas.k2hdkc.antpick.ax/images/overview.png)
The overall **K2HDKC DBaaS CLI** overview diagram is shown below.

![K2HDKC DBaaS system](https://dbaas.k2hdkc.antpick.ax/images/overview_cli.png)

### K2HR3 System Overview
**K2HR3** (**K2H**dkc based **R**esource and **R**oles and policy **R**ules) is one of extended **RBAC** (**R**ole **B**ased **A**ccess **C**ontrol) system.
Expand All @@ -30,28 +38,29 @@ K2HR3 is a system that defines and controls **HOW**(policy Rule), **WHO**(Role),
Users of K2HR3 can define **Role**(WHO) groups to access freely defined **Resource**(WHAT) and control access by **policy Rule**(HOW).
By defining the information and assets required for any system as a **Resource**(WHAT), K2HR3 system can give the opportunity to provide access control in every situation.

K2HR3 provides **+SERVICE** feature, it **strongly supports** user system, function and information linkage.
K2HR3 provides **+SERVICE** feature, it **strongly supports** user system, function and information linkage.

![K2HR3 system overview](https://k2hr3.antpick.ax/images/overview_abstract.png)

K2HR3 is built [k2hdkc](https://github.com/yahoojapan/k2hdkc), [k2hash](https://github.com/yahoojapan/k2hash), [chmpx](https://github.com/yahoojapan/chmpx) and [k2hash transaction plugin](https://github.com/yahoojapan/k2htp_dtor) components by [AntPickax](https://antpick.ax/).
K2HR3 is built [k2hdkc](https://github.com/yahoojapan/k2hdkc), [k2hash](https://github.com/yahoojapan/k2hash), [chmpx](https://github.com/yahoojapan/chmpx) and [k2hash transaction plugin](https://github.com/yahoojapan/k2htp_dtor) components by [AntPickax](https://antpick.ax/).

## Documents
[K2HDKC DBaaS Document](https://dbaas.k2hdkc.antpick.ax/index.html)
[Github wiki page](https://github.com/yahoojapan/k2hdkc_dbaas_cli/wiki)

[About k2hdkc Document](https://k2hdkc.antpick.ax/index.html)
[About k2hr3 Document](https://k2hr3.antpick.ax/index.html)
[About chmpx Document](https://chmpx.antpick.ax/index.html)
[About k2hr3 Document](https://k2hr3.antpick.ax/index.html)

[About AntPickax](https://antpick.ax/)

## Repositories
[k2hdkc dbaas](https://github.com/yahoojapan/k2hdkc_dbaas)
[k2hdkc_dbaas](https://github.com/yahoojapan/k2hdkc_dbaas)
[k2hdkc_dbaas_k8s_cli](https://github.com/yahoojapan/k2hdkc_dbaas_k8s_cli)
[k2hr3](https://github.com/yahoojapan/k2hr3)
[k2hr3_app](https://github.com/yahoojapan/k2hr3_app)
[k2hr3_api](https://github.com/yahoojapan/k2hr3_api)
[k2hr3_cli](https://github.com/yahoojapan/k2hr3_cli)
[k2hr3_get_resource](https://github.com/yahoojapan/k2hr3_get_resource)
[k2hdkc](https://github.com/yahoojapan/k2hdkc)
[k2hdkc_dbaas_override_conf](https://github.com/yahoojapan/k2hdkc_dbaas_override_conf)
Expand All @@ -60,6 +69,8 @@ K2HR3 is built [k2hdkc](https://github.com/yahoojapan/k2hdkc), [k2hash](https://
## Packages
[k2hdkc(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=k2hdkc)
[chmpx(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=chmpx)
[k2hdkc-dbaas-cli(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=k2hdkc-dbaas-cli)
[k2hdkc-dbaas-k8s-cli(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=k2hdkc-dbaas-k8s-cli)
[k2hdkc-dbaas-override-conf(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=k2hdkc-dbaas-override-conf)
[k2hr3-cli(packagecloud.io)](https://packagecloud.io/app/antpickax/stable/search?q=k2hr3-cli)
[k2hr3-app(npm packages)](https://www.npmjs.com/package/k2hr3-app)
Expand Down

0 comments on commit 40c8ed0

Please sign in to comment.