-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-generated cli documentation update - 2024-01-31 13:44:42 (#2233)
Update documentation Co-authored-by: JAORMX <[email protected]>
- Loading branch information
1 parent
e4c3757
commit b2ebf6d
Showing
6 changed files
with
197 additions
and
0 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
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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: minder project | ||
--- | ||
## minder project | ||
|
||
Manage project within a minder control plane | ||
|
||
### Synopsis | ||
|
||
The minder project commands manage projects within a minder control plane. | ||
|
||
``` | ||
minder project [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for project | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $PWD/config.yaml) | ||
--grpc-host string Server host (default "api.stacklok.com") | ||
--grpc-insecure Allow establishing insecure connections | ||
--grpc-port int Server port (default 443) | ||
--identity-client string Identity server client ID (default "minder-cli") | ||
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [minder](minder.md) - Minder controls the hosted minder service | ||
* [minder project role](minder_project_role.md) - Manage roles within a minder control plane | ||
|
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: minder project role | ||
--- | ||
## minder project role | ||
|
||
Manage roles within a minder control plane | ||
|
||
### Synopsis | ||
|
||
The minder role commands manage permissions within a minder control plane. | ||
|
||
``` | ||
minder project role [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for role | ||
-j, --project string ID of the project | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $PWD/config.yaml) | ||
--grpc-host string Server host (default "api.stacklok.com") | ||
--grpc-insecure Allow establishing insecure connections | ||
--grpc-port int Server port (default 443) | ||
--identity-client string Identity server client ID (default "minder-cli") | ||
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [minder project](minder_project.md) - Manage project within a minder control plane | ||
* [minder project role deny](minder_project_role_deny.md) - Deny a role to a subject on a project within the minder control plane | ||
* [minder project role grant](minder_project_role_grant.md) - Grant a role to a subject on a project within the minder control plane | ||
* [minder project role list](minder_project_role_list.md) - List roles on a project within the minder control plane | ||
|
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: minder project role deny | ||
--- | ||
## minder project role deny | ||
|
||
Deny a role to a subject on a project within the minder control plane | ||
|
||
### Synopsis | ||
|
||
The minder project role deny command removes a user from a role grant | ||
on a particular project. | ||
|
||
``` | ||
minder project role deny [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for deny | ||
-r, --role string the role to grant | ||
-s, --sub string subject to grant access to | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $PWD/config.yaml) | ||
--grpc-host string Server host (default "api.stacklok.com") | ||
--grpc-insecure Allow establishing insecure connections | ||
--grpc-port int Server port (default 443) | ||
--identity-client string Identity server client ID (default "minder-cli") | ||
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com") | ||
-j, --project string ID of the project | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [minder project role](minder_project_role.md) - Manage roles within a minder control plane | ||
|
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: minder project role grant | ||
--- | ||
## minder project role grant | ||
|
||
Grant a role to a subject on a project within the minder control plane | ||
|
||
### Synopsis | ||
|
||
The minder project role grant command allows one to grant a role | ||
to a user (subject) on a particular project. | ||
|
||
``` | ||
minder project role grant [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for grant | ||
-r, --role string the role to grant | ||
-s, --sub string subject to grant access to | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $PWD/config.yaml) | ||
--grpc-host string Server host (default "api.stacklok.com") | ||
--grpc-insecure Allow establishing insecure connections | ||
--grpc-port int Server port (default 443) | ||
--identity-client string Identity server client ID (default "minder-cli") | ||
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com") | ||
-j, --project string ID of the project | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [minder project role](minder_project_role.md) - Manage roles within a minder control plane | ||
|
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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: minder project role list | ||
--- | ||
## minder project role list | ||
|
||
List roles on a project within the minder control plane | ||
|
||
### Synopsis | ||
|
||
The minder project role list command allows one to list roles | ||
available on a particular project. | ||
|
||
``` | ||
minder project role list [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for list | ||
-o, --output string Output format (one of json,yaml,table) (default "table") | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $PWD/config.yaml) | ||
--grpc-host string Server host (default "api.stacklok.com") | ||
--grpc-insecure Allow establishing insecure connections | ||
--grpc-port int Server port (default 443) | ||
--identity-client string Identity server client ID (default "minder-cli") | ||
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com") | ||
-j, --project string ID of the project | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [minder project role](minder_project_role.md) - Manage roles within a minder control plane | ||
|