Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stackstorm/st2-rbac-backend

RBAC backend for StackStorm (previously part of EWC aka StackStorm Enteprise)
https://github.com/stackstorm/st2-rbac-backend

backend python rbac st2 stackstorm

Last synced: 2 months ago
JSON representation

RBAC backend for StackStorm (previously part of EWC aka StackStorm Enteprise)

Host: GitHub
URL: https://github.com/stackstorm/st2-rbac-backend
Owner: StackStorm
License: apache-2.0
Created: 2019-03-11T18:04:22.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-02-04T22:26:50.000Z (11 months ago)
Last Synced: 2024-02-04T23:34:45.585Z (11 months ago)
Topics: backend, python, rbac, st2, stackstorm
Language: Python
Homepage: https://docs.stackstorm.com/latest/rbac.html
Size: 545 KB
Stars: 3
Watchers: 11
Forks: 11
Open Issues: 12
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# RBAC Backend for StackStorm

[![RBAC Unit Tests Status](https://github.com/StackStorm/st2-rbac-backend/actions/workflows/lint-and-unit-tests.yml/badge.svg)](https://github.com/StackStorm/st2-rbac-backend/actions/workflows/lint-and-unit-tests.yml)

The RBAC backend started as part of StackStorm core repo and then moved out into a separate
repo for enterprise purposes. Some enterprise features such as RBAC has been made open
sourced as part of the donation to Linux Foundation in 2019.

NOTE: Due to the original code structure and the code originally living as part of the
open source StackStorm/st2 repo, some of the utility RBAC code is still part of the open
source repo (that code is of little use without the permission resolving classes which
contain majority of the business logic though).

## Installation

NOTE: This happens automatically when using bwc installer script.

1. Make sure the backend Python package is installed inside StackStorm virtualenv
(``/opt/stackstorm/st2/``)
2: Edit StackStorm config (``/etc/st2/st2.conf``):

```ini
...
[rbac]
enable = True
backend = default
...
3. Restart all the services - ``sudo st2ctl restart``

## Running Lint Checks and Tests

To run lint checks and unit tests you can use ``lint`` and ``unit-tests`` make targets.
This will clone ``StackStorm/st2`` repo into ``/tmp/st2``, install StackStorm dependencies in
a purpose built virtual environment and add all StackStorm Python packages from
``/tmp/st2`` into ``PYTHONPATH`` for those make targets.

```bash
make lint
make unit-tests
```

If virtual environment is already created and all the dependencies installed, you can skip
dependency steps by simply running lint and tests:

```bash
make .lint
make .unit-tests
```

If you want to test those changes against a specific version of StackStorm/st2 repo, you can set
``ST2_REPO_BRANCH`` environment variable. For example:

```bash
ST2_REPO_BRANCH=my-super-feature make unit-tests
```

Keep in mind that you can also simply symlink your working copy of ``StackStorm/st2`` repo to
``/tmp/st2``. This way you can test changes with your work which hasn't been committed / pushed
upstream yet.

## Copyright, License, and Contributors Agreement

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project.