Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update docs #32

Merged
merged 1 commit into from
May 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@

!Makefile

!assets/*

# ...even if they are in subdirectories
!*/

45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
# RBAC Wizard
<div align="center" style="padding-top: 5px">
<img src="/ui/public/rbac-wizard-logo-embedded.svg?raw=true" width="120">
</div>

# RBAC Wizard

RBAC Wizard is a tool that helps you visualize and analyze the RBAC configurations of your Kubernetes cluster. It provides a graphical representation of the Kubernetes RBAC objects.

<div align="center">


| Demo |
|--------------------------------------------|
| <img src="/assets/rbac-wizard-demo.gif" /> |

</div>

## How to install

### Using go install

```bash
go install github.com/pehlicd/rbac-wizard@latest
```

## How to use

Using RBAC Wizard is super simple. Just run the following command:

```bash
rbac-wizard serve
```

## How to contribute

If you'd like to contribute to RBAC Wizard, feel free to submit pull requests or open issues on the [GitHub repository](https://github.com/pehlicd/rbac-wizard). Your feedback and contributions are highly appreciated!

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Developed by [Furkan Pehlivan](https://github.com/pehlicd) - [Project Repository](https://github.com/pehlicd/rbac-wizard)
Binary file added assets/rbac-wizard-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions ui/public/rbac-wizard-logo-embedded.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.