Giter Club home page Giter Club logo

st2-rbac-backend's Introduction

RBAC Backend for StackStorm

RBAC Unit Tests Status

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):
...
[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:

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:

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

Copyright 2015-2020 Extreme Networks, Inc.

Copyright 2020 StackStorm, Inc.

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 file, or at:

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.

st2-rbac-backend's People

Contributors

kami avatar m4dcoder avatar sagarvasav-admin avatar ankita-orchestral avatar amanda11 avatar ashwini-orchestral avatar armab avatar arm4b avatar lindsayhill avatar blag avatar cognifloyd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.