forked from raystack/frontier
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: migrate odpf to goto * feat: fix docs acton * fix: gotocompany namesapces * readme: fix typo * fix: buf-gen validation plugin --------- Co-authored-by: Muhammad Abduh <[email protected]> Co-authored-by: Ishan Arya <[email protected]>
- Loading branch information
1 parent
96d2530
commit 7f2d04a
Showing
183 changed files
with
3,680 additions
and
4,102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,4 +27,4 @@ jobs: | |
push: true | ||
file: "./Dockerfile.dev" | ||
tags: | | ||
odpf/shield:dev | ||
gotocompany/shield:dev |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Shield | ||
|
||
![build workflow](https://github.com/odpf/shield/actions/workflows/test.yml/badge.svg) | ||
![package workflow](https://github.com/odpf/shield/actions/workflows/release.yml/badge.svg) | ||
![build workflow](https://github.com/goto/shield/actions/workflows/test.yml/badge.svg) | ||
![package workflow](https://github.com/goto/shield/actions/workflows/release.yml/badge.svg) | ||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE) | ||
[![Version](https://img.shields.io/github/v/release/odpf/shield?logo=semantic-release)](Version) | ||
[![Coverage Status](https://coveralls.io/repos/github/odpf/shield/badge.svg?branch=main)](https://coveralls.io/github/odpf/shield?branch=main) | ||
[![Version](https://img.shields.io/github/v/release/goto/shield?logo=semantic-release)](Version) | ||
[![Coverage Status](https://coveralls.io/repos/github/goto/shield/badge.svg?branch=main)](https://coveralls.io/github/goto/shield?branch=main) | ||
|
||
Shield is a cloud native role-based authorization aware server and reverse-proxy system. With Shield, you can assign roles to users or groups of users to configure policies that determine whether a particular user has the ability to perform a certain action on a given resource. | ||
|
||
|
@@ -30,20 +30,20 @@ Discover why users choose Shield as their authorization proxy | |
|
||
## Installation | ||
|
||
Install Shield on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. Refer this for [installations](https://odpf.github.io/shield/docs/installation). | ||
Install Shield on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. Refer this for [installations](https://goto.github.io/shield/docs/installation). | ||
|
||
#### Binary (Cross-platform) | ||
|
||
Download the appropriate version for your platform from [releases](https://github.com/odpf/shield/releases) page. Once downloaded, the binary can be run from anywhere. | ||
Download the appropriate version for your platform from [releases](https://github.com/goto/shield/releases) page. Once downloaded, the binary can be run from anywhere. | ||
You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. | ||
Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location. | ||
|
||
#### macOS | ||
|
||
`shield` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/shield/releases/latest) page: | ||
`shield` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/goto/shield/releases/latest) page: | ||
|
||
```sh | ||
brew install odpf/tap/shield | ||
brew install goto/tap/shield | ||
``` | ||
|
||
To upgrade to the latest version: | ||
|
@@ -60,14 +60,14 @@ shield version | |
|
||
#### Linux | ||
|
||
`shield` is available as downloadable binaries from the [releases](https://github.com/odpf/shield/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively. | ||
`shield` is available as downloadable binaries from the [releases](https://github.com/goto/shield/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively. | ||
|
||
#### Windows | ||
|
||
`shield` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/shield/releases/latest) page: | ||
`shield` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/goto/shield/releases/latest) page: | ||
|
||
``` | ||
scoop bucket add shield https://github.com/odpf/scoop-bucket.git | ||
scoop bucket add shield https://github.com/goto/scoop-bucket.git | ||
``` | ||
|
||
To upgrade to the latest version: | ||
|
@@ -81,20 +81,20 @@ scoop update shield | |
We provide ready to use Docker container images. To pull the latest image: | ||
|
||
``` | ||
docker pull odpf/shield:latest | ||
docker pull gotocompany/shield:latest | ||
``` | ||
|
||
To pull a specific version: | ||
|
||
``` | ||
docker pull odpf/shield:v0.3.2 | ||
docker pull gotocompany/shield:v0.3.2 | ||
``` | ||
|
||
If you like to have a shell alias that runs the latest version of shield from docker whenever you type `shield`: | ||
|
||
``` | ||
mkdir -p $HOME/.config/odpf | ||
alias shield="docker run -e HOME=/tmp -v $HOME/.config/odpf:/tmp/.config/odpf --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp odpf/shield:latest" | ||
mkdir -p $HOME/.config/gotocompany | ||
alias shield="docker run -e HOME=/tmp -v $HOME/.config/gotocompany:/tmp/.config/gotocompany --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp gotocompany/shield:latest" | ||
``` | ||
|
||
## Usage | ||
|
@@ -119,7 +119,7 @@ shield reference | |
|
||
#### API | ||
|
||
Shield provides a fully-featured GRPC and HTTP API to interact with Shield server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/odpf/proton/tree/main/odpf/shield/v1beta1) for GRPC API definitions. | ||
Shield provides a fully-featured GRPC and HTTP API to interact with Shield server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/goto/proton/tree/main/goto/shield/v1beta1) for GRPC API definitions. | ||
|
||
## Running locally | ||
|
||
|
@@ -135,7 +135,7 @@ Shield provides a fully-featured GRPC and HTTP API to interact with Shield serve | |
Clone the repo | ||
|
||
``` | ||
git clone [email protected]:odpf/shield.git | ||
git clone [email protected]:goto/shield.git | ||
``` | ||
|
||
Install all the golang dependencies | ||
|
@@ -184,14 +184,14 @@ $ make coverage | |
Development of Shield happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and | ||
improvements. Read below to learn how you can take part in improving Shield. | ||
|
||
Read our [contributing guide](https://odpf.github.io/shield/docs/contribute/contribution) to learn about our development process, how to propose | ||
Read our [contributing guide](https://goto.github.io/shield/docs/contribute/contribution) to learn about our development process, how to propose | ||
bugfixes and improvements, and how to build and test your changes to Shield. | ||
|
||
To help you get your feet wet and get you familiar with our contribution process, we have a list of | ||
[good first issues](https://github.com/odpf/shield/labels/good%20first%20issue) that contain bugs which have a relatively | ||
[good first issues](https://github.com/goto/shield/labels/good%20first%20issue) that contain bugs which have a relatively | ||
limited scope. This is a great place to get started. | ||
|
||
This project exists thanks to all the [contributors](https://github.com/odpf/shield/graphs/contributors). | ||
This project exists thanks to all the [contributors](https://github.com/goto/shield/graphs/contributors). | ||
|
||
## License | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.