README
¶
Release Operate Report
What is ROR
ROR is a vendor-agnostic eco-system for resources. For more detailed explanation see here.
Documentation
The documentation is automatically built and available at norskhelsenett.github.io/ror, see it for more detailed information.
For more information about the documentation see here.
ROR Eco-System
For a complete list and more information see here.
The ROR ecosystem is made out of multiple repositories to separate each major component. Other components such as microservices and "addons" are also separated out to be a clear distinction between what is ROR and what is an implementation of a resource to ROR. A complete list can be found here
Features
Installation
For a local installation see here. For a kubernetes installation see here.
Installation from source
See BUILD.md and supported platforms for details.
The build is CMake-based, but a Makefile is provided as a convenience.
Project layout
├─ charts/ helm charts for the entire ROR eco-system
├─ cmd/ executable files related to the ROR Core
│ ├─ docs/ contain dockerfile and doc automation
│ ├─ generator/ starts the generator to generate files
├─ docs/ documentation for the mkdocs
├─ hacks/ files for local development environment
│ ├─ assets/ TODO
│ ├─ data/ Mix of configuration files and container mounts.
│ ├─ scripts/ various scripts for mocking k8s cluster, mongodb, etc.
├─ media/ various media (pictures, videos, etc) of ror
├─ pkg/ various subsectioned parts of ror
│ ├─ apicontracts/ TODO
│ ├─ auth/ authorization packges, ldap, ad, userauth, etc.
│ ├─ clients/ various clients
│ ├─ config/ TODO
│ ├─ context/ TODO
│ ├─ handlers/ TODO
│ ├─ helpers/ TODO
│ ├─ kubernetes/ TODO
│ ├─ messagebuscontracts/ TODO
│ ├─ models/ various models used in the ror eco-system
│ ├─ rlog/ logging package used in the ror eco-system
│ ├─ rorresources/ resource, resourcetypes, api, etc. definitions. TODO
│ ├─ services/ TODO
│ └─ telemetry/ telemetry (metrics, trace) package used
├─ typescript/ generated typescript based on Go code for frontend
├─ mkdocs-requirements.txt requirements for bringing up mkdocs.
├─ mkdocs.yml mkdocs navigation paths.
└─ r.sh starting script, copies files and start docker environment
License
See LICENSE
Run ROR?
See ROR-API README for more information on how to bring up a development environment.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
generator
command
The Generator package provides a way to generate code for collecting, transfering and saving resources in the agent and api.
|
The Generator package provides a way to generate code for collecting, transfering and saving resources in the agent and api. |
|
pkg
|
|
|
apicontracts/apiresourcecontracts
package delivers apicontracts for resources in the V1 API Deprecated: This package is deprecated.
|
package delivers apicontracts for resources in the V1 API Deprecated: This package is deprecated. |
|
auth/userauth/msgraph
This package contains the msgraph package which is used to interact with the Microsoft Graph API it implements the UserWithGroup struct and the GraphClient struct
|
This package contains the msgraph package which is used to interact with the Microsoft Graph API it implements the UserWithGroup struct and the GraphClient struct |
|
clients/cyberark
Package cyberark provides functionality for interacting with CyberArk's password vault API.
|
Package cyberark provides functionality for interacting with CyberArk's password vault API. |
|
clients/gitclient
Package gitclient provides a simple Git client for updating files in remote repositories using in-memory operations.
|
Package gitclient provides a simple Git client for updating files in remote repositories using in-memory operations. |
|
clients/kubernetes/dynamicwatcher
package dynamic watcher provides a way to watch for changes in kubernetes resources the function Start takes a kubernetes clientset and a list of DynamicWatcherConfig and starts a watcher for each configuration
|
package dynamic watcher provides a way to watch for changes in kubernetes resources the function Start takes a kubernetes clientset and a list of DynamicWatcherConfig and starts a watcher for each configuration |
|
clients/redisdb
Package implements the redis database helpers
|
Package implements the redis database helpers |
|
clients/rorclient/transports/resttransport/httpclient
Package httpclient provides an HTTP transport implementation for interacting with ROR APIs.
|
Package httpclient provides an HTTP transport implementation for interacting with ROR APIs. |
|
clients/rorclient/v2/transports/resttransport/httpclient
Package httpclient provides an HTTP transport implementation for interacting with ROR APIs.
|
Package httpclient provides an HTTP transport implementation for interacting with ROR APIs. |
|
config/rorconfig
Package rorconfig provides a centralized configuration management system for ROR applications.
|
Package rorconfig provides a centralized configuration management system for ROR applications. |
|
context/mscontext
The package provides ror-context for services
|
The package provides ror-context for services |
|
context/rorcontext
Package contextservices The package provides functions to get and work with ror contexts
|
Package contextservices The package provides functions to get and work with ror contexts |
|
helpers/k8sportforwarder
Package k8sportforwarder is responsible for forwarding ports from a pod to the local machine.
|
Package k8sportforwarder is responsible for forwarding ports from a pod to the local machine. |
|
helpers/rorerror/v2
Package rorerror provides structured error handling for HTTP APIs with Gin framework integration.
|
Package rorerror provides structured error handling for HTTP APIs with Gin framework integration. |
|
helpers/tokenstoragehelper
Package tokenstoragehelper provides a secure token storage and key management system for JWT token signing and rotation.
|
Package tokenstoragehelper provides a secure token storage and key management system for JWT token signing and rotation. |
|
helpers/tokenstoragehelper/vaulttokenadapter
Package vaulttokenadapter provides a HashiCorp Vault implementation of the StorageAdapter interface for persisting JWT signing keys.
|
Package vaulttokenadapter provides a HashiCorp Vault implementation of the StorageAdapter interface for persisting JWT signing keys. |
|
models/aclmodels
aclmodels contains models for acl v1 and v2
|
aclmodels contains models for acl v1 and v2 |
|
models/identity
Package implements models representing identity
|
Package implements models representing identity |
|
rlog
Package rlog provides a structured logging library for the ROR project.
|
Package rlog provides a structured logging library for the ROR project. |
|
rorresources/rordefs
The package provides the models and variables needed to generate code and endpoints for the implemented rorresources
|
The package provides the models and variables needed to generate code and endpoints for the implemented rorresources |
|
rorresources/rortypes
package delivers apicontracts for resources
|
package delivers apicontracts for resources |
Click to show internal directories.
Click to hide internal directories.