k2hr3: A repository from Yahoo! JAPAN

K2HR3

K2HR3 - K2Hdkc based Resource and Roles and policy Rules

K2HR3 system overview

K2HR3 (K2Hdkc based Resource and Roles and policy Rules) is one of extended RBAC (Role Based Access Control) system.
K2HR3 works as RBAC in cooperation with OpenStack and kubernetes which is one of IaaS(Infrastructure as a Service), and also provides useful functions for using RBAC.

K2HR3 is a system that defines and controls HOW(policy Rule), WHO(Role), WHAT(Resource), as RBAC.
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 is built k2hdkc, k2hash, chmpx and k2hash transaction plugin components by AntPickax.

K2HR3 Systems/Components

The K2HR3 system consists of several subsystems and components.
They are registered as submodules in this repository.
Below is a brief description of each submodule.

K2HR3 Web Application

K2HR3 Web Application is one subsystem of K2HR3 system.
This is accessed from the browser by users and operates as the control panel of the K2HR3 system.
This is a JavaScript based web application that can manipulate all of the data required by users.
K2HR3 Web Application is created with React.js and Node.js.

User can manipulate Roles, policy Rules, Resource, Service data using this K2HR3 Web Application.

Demonstration site

You can access the demonstration site of K2HR3 Web Application by accessing here.
You can learn about Resource, Roles, policy Rules and SERVICE provided by K2HR3 on this site now.
The data operated on this site can not be saved.

K2HR3 Command Line Interface

K2HR3 Command Line Interface(CLI) provides an interface that allows you to operate the K2HR3 REST API provided by K2HR3 from the command line.
It provides the same function as K2HR3 Web Application for manipulating the data of the K2HR3 system as a Command Line Interface(CLI).

K2HR3 REST API

K2HR3 REST API provides for manipulating data such as ROLE, POLICY RULE, RESOURCE and SERVICE stored in the K2HR3 Data Server(k2hdkc).

Using the K2HR3 REST API provided by this K2HR3 API server, the K2HR3 Web Application and its Web Server communicates with the K2HR3 Data Server(k2hdkc).
And users and hosts of the ROLE member directly call this K2HR3 REST API on this K2HR3 API Server, and get/put RESOURCE data.

K2HR3 REST API and K2HR3 API Server is the server side JavaScript program running on Node.js.

K2HR3 OpenStack Notification Listener

K2HR3 OpenStack Notification Listener is an OpenStack Notification Listener that listens to notifications from OpenStack services.
OpenStack services emit notifications to the message bus, which is provided by oslo.messaging transports notification messages to a message broker server.
The default broker server is RabbitMQ.
When K2HR3 OpenStack Notification Listener catches a notification message from RabbitMQ, it sends the payload to the K2hR3 system.

K2HR3 Utilities

K2HR3 Utilities is a utility for the quick setup K2HR3 system.
This will easily set up all the subcomponents of the K2HR3 system(K2HR3 Web Application and Web Server, K2HR3 REST API, K2HR3 Data Server(k2hdkc), K2HR3 OpenStack Notification Listener). You can test the K2HR3 system in this environment. Before using K2HR3 Utilities, OpenStack must be set up in the your environment.

How to use K2HR3 Utilities is explained in K2HR3 Setup.

K2HR3 Container Registration Sidecar

K2HR3 Container Registration Sidecar is a sidecar docker image for container registration to K2HR3 systems.
This is a repository for creating docker images and publishing it on dockerhub.
If you use the K2HR3 system to register a container, you can use the K2HR3 Web Application and get yaml to register a Sidecar that uses this image.
You can start sidecar using the obtained yaml from K2HR3 Web Application.

K2HR3 Get Resource

K2HR3 Get Resource can be used in an environment where virtual computing(Virtual Machine) is started using User Data Script(for OpenStack) and automatically registered in the ROLE.
K2HR3 Get Resource is a Systemd timer service that periodically acquires the RESOURCE corresponding to the ROLE in which the virtual computing(Virtual Machine) is registered.
By using this, you can periodically acquire RESOURCE data and output it to a file or the like.

K2HR3 Helm Chart

K2HR3 Helm Chart is a Helm Chart for building a K2HR3 system using Helm(The package manager for Kubernetes) in a kubernetes environment.
By using this Helm Chart, you can easily build a K2HR3 system in a kubernetes environment.
This can be used to build a K2HR3 system before using the K2HDKC Helm Chart to build a K2HDKC DBaaS in a kubernetes environment.