├── docs ├── .keep ├── README.md ├── guide │ ├── .keep │ ├── zh-CN │ │ ├── .keep │ │ ├── README.md │ │ ├── api │ │ │ └── .keep │ │ ├── catalog.md │ │ ├── faq │ │ │ └── .keep │ │ ├── sdk │ │ │ └── .keep │ │ ├── quickstart │ │ │ └── .keep │ │ ├── best-practice │ │ │ └── .keep │ │ ├── installation │ │ │ └── .keep │ │ ├── introduction │ │ │ └── .keep │ │ └── operation-guide │ │ │ └── .keep │ └── en-US │ │ ├── yaml │ │ └── projctl │ │ │ ├── projctl_set.yaml │ │ │ ├── projctl_info.yaml │ │ │ ├── projctl_jwt.yaml │ │ │ ├── projctl_options.yaml │ │ │ ├── projctl_validate.yaml │ │ │ ├── projctl_secret.yaml │ │ │ ├── projctl_policy.yaml │ │ │ ├── projctl_user.yaml │ │ │ ├── projctl.yaml │ │ │ ├── projctl_version.yaml │ │ │ ├── projctl_color.yaml │ │ │ ├── projctl_new.yaml │ │ │ └── projctl_completion.yaml │ │ └── cmd │ │ └── projctl │ │ ├── projctl_set.md │ │ ├── projctl_info.md │ │ ├── projctl_user_get.md │ │ ├── projctl_secret_delete.md │ │ ├── projctl_secret_get.md │ │ ├── projctl_options.md │ │ ├── projctl_policy_delete.md │ │ ├── projctl_policy_get.md │ │ ├── projctl_validate.md │ │ ├── projctl_jwt_show.md │ │ ├── projctl_jwt_verify.md │ │ ├── projctl_user_delete.md │ │ ├── projctl_jwt.md │ │ ├── projctl_secret_update.md │ │ ├── projctl_secret_list.md │ │ ├── projctl_version.md │ │ ├── projctl_user_list.md │ │ ├── projctl_policy_list.md │ │ ├── projctl_user_create.md │ │ ├── projctl_user_update.md │ │ ├── projctl_secret.md │ │ ├── projctl_policy_create.md │ │ ├── projctl_policy_update.md │ │ ├── projctl_secret_create.md │ │ └── projctl_policy.md ├── images │ ├── .keep │ ├── logo.png │ └── superporj-arch.png ├── devel │ ├── zh-CN │ │ ├── architecture.md │ │ ├── name_relationship.md │ │ ├── conversions │ │ │ ├── validation.md │ │ │ ├── mysql-fields.md │ │ │ ├── flag.md │ │ │ ├── package.md │ │ │ ├── curd.md │ │ │ ├── git-commit.md │ │ │ ├── ports.md │ │ │ ├── log.md │ │ │ └── conversions.md │ │ ├── future.md │ │ └── blockchain-installation.md │ └── en-US │ │ └── contributors │ │ └── git_workflow.png ├── man │ └── man1 │ │ ├── projctl-set.1 │ │ ├── projctl-jwt.1 │ │ ├── projctl-info.1 │ │ ├── projctl-user-get.1 │ │ ├── projctl-secret-delete.1 │ │ ├── projctl-secret-get.1 │ │ ├── projctl-policy-get.1 │ │ ├── projctl-options.1 │ │ ├── projctl-policy-delete.1 │ │ ├── projctl-validate.1 │ │ ├── projctl-secret.1 │ │ ├── projctl-policy.1 │ │ ├── projctl-user-delete.1 │ │ ├── projctl-jwt-show.1 │ │ ├── projctl-jwt-verify.1 │ │ ├── projctl-user.1 │ │ └── projctl-secret-update.1 └── .generated_docs ├── README-en.md ├── .github └── PULL_REQUEST_TEMPLATE.md ├── .gitlint ├── .gsemver.yaml ├── .chglog ├── CHANGELOG.tpl.md └── config.yml ├── .kube-linter.yaml └── .air.toml /docs/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/images/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/README.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/api/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/catalog.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/faq/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/sdk/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/architecture.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/quickstart/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/best-practice/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/installation/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/introduction/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/guide/zh-CN/operation-guide/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/name_relationship.md: -------------------------------------------------------------------------------- 1 | # 名字映射关系 2 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/validation.md: -------------------------------------------------------------------------------- 1 | ## 请求校验规范 2 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/mysql-fields.md: -------------------------------------------------------------------------------- 1 | ## 数据库字段规范 2 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/flag.md: -------------------------------------------------------------------------------- 1 | ## 命令行Flag规范 2 | 3 | - 0.0.0.0::9090 这种风格的统一用Addr 4 | -------------------------------------------------------------------------------- /docs/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marmotedu/superproj/HEAD/docs/images/logo.png -------------------------------------------------------------------------------- /docs/images/superporj-arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marmotedu/superproj/HEAD/docs/images/superporj-arch.png -------------------------------------------------------------------------------- /README-en.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | English | [简体中文](./README.md) 4 | 5 | -------------------------------------------------------------------------------- /docs/devel/en-US/contributors/git_workflow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marmotedu/superproj/HEAD/docs/devel/en-US/contributors/git_workflow.png -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Sorry, we do not accept changes directly against this repository. Please see 2 | CONTRIBUTING.md for information on where and how to contribute instead. 3 | -------------------------------------------------------------------------------- /.gitlint: -------------------------------------------------------------------------------- 1 | --subject-regex=^((Merge branch.*)|((revert: )?(feat|fix|perf|style|refactor|test|ci|docs|chore)(\(.+\))?: [^A-Z].*[^.]$)) 2 | --subject-maxlen=120 3 | --body-regex=^([^\r\n]{0,120}(\r?\n|$))*$ 4 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/package.md: -------------------------------------------------------------------------------- 1 | ## 包名规范 2 | 3 | - `api "github.com/superproj/superproj/pkg/apis/core"` 4 | - `apiv1 "github.com/superproj/superproj/pkg/apis/core/v1"` 5 | - `corev1 "k8s.io/api/core/v1"` 6 | - `"k8s.io/api/core"` 7 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/curd.md: -------------------------------------------------------------------------------- 1 | ## 业务CURD规范 2 | 3 | - K8S资源，例如：MinerSet/Miner具有以下行为： 4 | - Create：返参是v1beta1.MinerXXX 5 | - Update: 返参是v1beta1.MinerXXX 6 | - Get: 返参是v1beta1.MinerXXX 7 | - List: 入参是ListMinerXXXRequest，返回参数是ListMinerXXXResponse(考虑到性能问题) 8 | - Delete: ... 9 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/future.md: -------------------------------------------------------------------------------- 1 | ## 未来实现的功能 2 | 3 | - Linters: 4 | - id 5 | - model 6 | - validate-func 7 | - Server: 8 | - superproj-event-monitor 9 | - superproj-tyk-server 10 | - superproj-osscenter 11 | - superproj-operator 12 | - 授权策略配置(casbin) 13 | - 运营数据查看 14 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/git-commit.md: -------------------------------------------------------------------------------- 1 | ## Git Commit Message 规范 2 | 3 | Commit Message 遵循 [Angular规范](https://www.jianshu.com/p/c7e40dab5b05)。 4 | 5 | 所有的 Commit Message 均需要有 Scope，Scope 如下： 6 | 7 | | Scope | 描述 | 8 | | ---- | ---- | 9 | | minerset | superproj-minerset-controller 组件代码变更 | 10 | | miner | superproj-miner-controller 组件代码变更 | 11 | | apiserver | superproj-apiserver 组件代码变更 | 12 | | docs | 文档类的修改 | 13 | | pkg | pkg/目录下的包修改 | 14 | -------------------------------------------------------------------------------- /.gsemver.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2020 Lingfei Kong . All rights reserved. 2 | # Use of this source code is governed by a MIT style 3 | # license that can be found in the LICENSE file. 4 | 5 | majorPattern: "(?m)^BREAKING CHANGE:.*$" 6 | minorPattern: "^feat(?:\(.+\))?:.*" 7 | bumpStrategies: 8 | - branchesPattern: "^(master|release/.*)$" 9 | strategy: "AUTO" 10 | preRelease: false 11 | preReleaseTemplate: 12 | preReleaseOverwrite: false 13 | buildMetadataTemplate: 14 | - branchesPattern: ".*" 15 | strategy: "AUTO" 16 | preRelease: false 17 | preReleaseTemplate: 18 | preReleaseOverwrite: false 19 | buildMetadataTemplate: "{{Commits | len}}.{{(.Commits | first).Hash.Short}}" 20 | -------------------------------------------------------------------------------- /.chglog/CHANGELOG.tpl.md: -------------------------------------------------------------------------------- 1 | {{ range .Versions }} 2 | 3 | ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }}) 4 | 5 | {{ range .CommitGroups -}} 6 | ### {{ .Title }} 7 | 8 | {{ range .Commits -}} 9 | * {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} 10 | {{ end }} 11 | {{ end -}} 12 | 13 | {{- if .RevertCommits -}} 14 | ### Reverts 15 | 16 | {{ range .RevertCommits -}} 17 | * {{ .Revert.Header }} 18 | {{ end }} 19 | {{ end -}} 20 | 21 | {{- if .NoteGroups -}} 22 | {{ range .NoteGroups -}} 23 | ### {{ .Title }} 24 | 25 | {{ range .Notes }} 26 | {{ .Body }} 27 | {{ end }} 28 | {{ end -}} 29 | {{ end -}} 30 | {{ end -}} -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/ports.md: -------------------------------------------------------------------------------- 1 | ## superproj 端口列表 2 | 3 | Linux端口使用规则： 4 | 5 | - 0 不使用 6 | - 1–1023 系统保留,只能由root用户使用 7 | - 1024—4999 由客户端程序自由分配 8 | - 5000—65535 由服务器端程序自由分配 9 | 10 | 11 | superproj端口分配规则： 12 | 13 | wwxyz: 14 | - ww: 服务分类，从50开始 15 | - x: 程序自己分配模块类别，默认为0 16 | - y: 0 http, 1 https 2 grpc 17 | - z: 0 非health类,1 health类 18 | 19 | 20 | superproj-usercenter: 21 | http/https/rpc: 50000/50010/50020 22 | superproj-gw: 23 | http/https/rpc: 51000/51010/51020 24 | superproj-apiserver: 25 | http/https/rpc: 52000/52010/52020 26 | superproj-osscenter: 27 | http/https/rpc: 53000/53010/53020 28 | superproj-nightwatch: 29 | health: 54001 30 | superproj-pump: 31 | health: 55001 32 | superproj-tky-server: 33 | http/https/rpc: 56000/56010/56020 34 | superproj-event-monitor: 35 | health: 57001 36 | swagger server: 37 | http: 65534 38 | -------------------------------------------------------------------------------- /.chglog/config.yml: -------------------------------------------------------------------------------- 1 | # Copyright 2020 Lingfei Kong . All rights reserved. 2 | # Use of this source code is governed by a MIT style 3 | # license that can be found in the LICENSE file. 4 | 5 | style: github 6 | template: CHANGELOG.tpl.md 7 | info: 8 | title: CHANGELOG 9 | repository_url: https://github.com/superproj/superproj 10 | options: 11 | commits: 12 | filters: 13 | Type: 14 | - feat 15 | - fix 16 | - break 17 | - deps 18 | - refactor 19 | - perf 20 | commit_groups: 21 | title_maps: 22 | feat: Features 23 | fix: Bug Fixes 24 | perf: Performance Improvements 25 | refactor: Code Refactoring 26 | break: Breaking Change 27 | deps: Dependencies 28 | header: 29 | pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$" 30 | pattern_maps: 31 | - Type 32 | - Scope 33 | - Subject 34 | notes: 35 | keywords: 36 | - BREAKING CHANGE 37 | -------------------------------------------------------------------------------- /.kube-linter.yaml: -------------------------------------------------------------------------------- 1 | # customChecks defines custom checks. 2 | customChecks: 3 | - name: "required-label-app" 4 | template: "required-label" 5 | params: 6 | key: "app" 7 | checks: 8 | # if doNotAutoAddDefaults is true, default checks are not automatically added. 9 | doNotAutoAddDefaults: false 10 | 11 | # addAllBuiltIn, if set, adds all built-in checks. This allows users to 12 | # explicitly opt-out of checks that are not relevant using Exclude. 13 | # Takes precedence over doNotAutoAddDefaults, if both are set. 14 | addAllBuiltIn: true 15 | 16 | # include explicitly adds checks, by name. You can reference any of the built-in checks. 17 | # Note that customChecks defined above are included automatically. 18 | # include: 19 | # - "required-label-owner" 20 | # exclude explicitly excludes checks, by name. exclude has the highest priority: if a check is 21 | # in exclude, then it is not considered, even if it is in include as well. 22 | exclude: 23 | - no-readiness-probe 24 | - dnsconfig-options 25 | - no-liveness-probe 26 | - required-annotation-email 27 | - required-label-app 28 | - required-label-owner 29 | - run-as-non-root 30 | - use-namespace 31 | - default-service-account 32 | - minimum-three-replicas 33 | - non-isolated-pod 34 | - no-node-affinity 35 | - no-read-only-root-fs 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/log.md: -------------------------------------------------------------------------------- 1 | ## 日志规范 2 | 3 | ### 常用日志规范 4 | 5 | - 为了跟K8S组件、生态兼容，所有日志均使用k8s.io/klog/v2 6 | - 最原始 报错位置打印一条日志即可 7 | - 统一使用 `k8s.io/klog/v2` 记录日志 8 | - 使用klog结构化日志方法记录日志：`klog.InfoS`, `klog.ErrorS`. Example: `klog.InfoS("Received HTTP request", "method", "GET", "URL", "/metrics", "latency", time.Second)` 9 | - 日志均以大写开头，结尾不跟 `.`，例如：`klog.InfoS("Received HTTP request")` 10 | - 使用过去时，例如：`Could not delete B` 而不是 `Cannot delete B` 11 | - 当提到一个对象时，说明它是什么类型的对象。例如：`Deleted pod` 而不是 `Deleted` 12 | - 遵循日志级别规范： 13 | - 所有错误统一使用`klog.ErrorS` 14 | - Warning级别的日志使用 `klog.V(1).InfoS` 15 | - Info级别的日志使用 `klog.V(2).InfoS` 16 | - Debug级别的日志使用 `klog.V(4/5/6).InfoS` 17 | - Debug时，经常需要查看的日志使用 `klog.V(4).InfoS` 18 | - Debug时，不经常需要查看的日志使用 `klog.V(5).InfoS` 19 | - Debug时，偶尔需要查看的日志使用 `klog.V(6).InfoS` 20 | 21 | > Notice: klog.V(0).InfoS = klog.InfoS 22 | 23 | 24 | ### 日志 `-v` 设置 25 | 26 | - 生产环境：`-v=2` 27 | - 开发测试环境：`-v=4` 28 | 29 | ### 其他规范可参考（recommended to follow） 30 | 31 | - [Kubernetes Logging Conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md) 32 | - [Structured and Contextual Logging migration instructions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#structured-logging-in-kubernetes) 33 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/blockchain-installation.md: -------------------------------------------------------------------------------- 1 | # TBB 区块链系统搭建指南 2 | 3 | ## 启动创世节点 4 | 5 | ``` 6 | $ ./scripts/get-genesis-account.sh $HOME/.tbb/genesis 7 | $ tbb run --datadir=$HOME/.tbb/genesis --disable-ssl --ip=0.0.0.0 --port=8080 --bootstrap-ip=0.0.0.0 --bootstrap-port=8080 --miner=0x210d9eD12CEA87E33a98AA7Bcb4359eABA9e800e 8 | ``` 9 | 10 | > 当--ip = --bootstrap-ip & --port = --bootstrap-port，tbb会认为这是一个genesis节点。参考：`github.com/web3coach/the-blockchain-bar/node/sync.go.doSync()` 11 | 12 | 13 | ## 创建节点 X 14 | 15 | ```bash 16 | $ tbb wallet new-account --datadir=$HOME/.tbb/nodex 17 | $ tbb run --datadir=$HOME/.tbb/nodex --disable-ssl --ip=0.0.0.0 --port=8081 --bootstrap-ip=127.0.0.1 --bootstrap-port=8080 --miner=
18 | ``` 19 | - *:* `tbb wallet new-account`命令生成的account 20 | 21 | ## 创建节点 Y 22 | 23 | ```bash 24 | $ tbb wallet new-account --datadir=$HOME/.tbb/nodey 25 | $ tbb run --datadir=$HOME/.tbb/nodey --disable-ssl --ip=0.0.0.0 --port=8081 --bootstrap-ip=127.0.0.1 --bootstrap-port=8080 --miner=
26 | ``` 27 | - *:* `tbb wallet new-account`命令生成的account 28 | 29 | ## 转账触发挖矿 30 | 31 | ```bash 32 | $ curl -XPOST http://127.0.0.1:8080/tx/add -d'{"from":"0x210d9eD12CEA87E33a98AA7Bcb4359eABA9e800","to":"0x210d9eD12CEA87E33a98AA7Bcb4359eABA9e800","value":10,"from_pwd":"iam59!z$"}' -H 'Accept: application/json' 33 | ``` 34 | 35 | ## 查看钱包余额 36 | 37 | ```bash 38 | $ curl -XPOST http://127.0.0.1:8080/balances/list 39 | ``` 40 | -------------------------------------------------------------------------------- /docs/devel/zh-CN/conversions/conversions.md: -------------------------------------------------------------------------------- 1 | # 开发规范 2 | 3 | ## 包名规范 4 | 5 | - `api "github.com/superproj/superproj/pkg/apis/core"` 6 | - `apiv1 "github.com/superproj/superproj/pkg/apis/core/v1"` 7 | - `corev1 "k8s.io/api/core/v1"` 8 | - `"k8s.io/api/core"` 9 | 10 | ## 日志规范 11 | 12 | ### 常用日志规范 13 | 14 | - 统一使用 `k8s.io/klog/v2` 记录日志 15 | - 使用klog结构化日志方法记录日志：`klog.InfoS`, `klog.ErrorS`. Example: `klog.InfoS("Received HTTP request", "method", "GET", "URL", "/metrics", "latency", time.Second)` 16 | - 日志均以大写开头，结尾不跟 `.`，例如：`klog.InfoS("Received HTTP request")` 17 | - 使用过去时，例如：`Could not delete B` 而不是 `Cannot delete B` 18 | - 当提到一个对象时，说明它是什么类型的对象。例如：`Deleted pod` 而不是 `Deleted` 19 | - 遵循日志级别规范： 20 | - 所有错误统一使用`klog.ErrorS` 21 | - Warning级别的日志使用 `klog.V(1).InfoS` 22 | - Info级别的日志使用 `klog.V(2).InfoS` 23 | - Debug级别的日志使用 `klog.V(4/5/6).InfoS` 24 | - Debug时，经常需要查看的日志使用 `klog.V(4).InfoS` 25 | - Debug时，不经常需要查看的日志使用 `klog.V(5).InfoS` 26 | - Debug时，偶尔需要查看的日志使用 `klog.V(6).InfoS` 27 | 28 | > Notice: klog.V(0).InfoS = klog.InfoS 29 | 30 | 31 | ### 日志 `-v` 设置 32 | 33 | - 生产环境：`-v=2` 34 | - 开发测试环境：`-v=4` 35 | 36 | ### 其他规范可参考（recommended to follow） 37 | 38 | - [Kubernetes Logging Conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md) 39 | - [Structured and Contextual Logging migration instructions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#structured-logging-in-kubernetes) 40 | 41 | ## Git Commit Message 规范 42 | 43 | Commit Message 遵循 [Angular规范](https://www.jianshu.com/p/c7e40dab5b05)。 44 | 45 | 所有的 Commit Message 均需要有 Scope，Scope 如下： 46 | 47 | | Scope | 描述 | 48 | | ---- | ---- | 49 | | minerset | superproj-minerset-controller 组件代码变更 | 50 | | miner | superproj-miner-controller 组件代码变更 | 51 | | apiserver | superproj-apiserver 组件代码变更 | 52 | | docs | 文档类的修改 | 53 | | pkg | pkg/目录下的包修改 | 54 | -------------------------------------------------------------------------------- /.air.toml: -------------------------------------------------------------------------------- 1 | # Config file for [Air](https://github.com/cosmtrek/air) in TOML format 2 | 3 | # Working directory 4 | # . or absolute path, please note that the directories following must be under root. 5 | root = "." 6 | tmp_dir = "tmp" 7 | 8 | [build] 9 | # Just plain old shell command. You could use `make` as well. 10 | cmd = "" 11 | # Binary file yields from `cmd`. 12 | bin = "" 13 | # Customize binary, can setup environment variables when run your app. 14 | #full_bin = "APP_ENV=dev APP_USER=air ./tmp/main" 15 | # Watch these filename extensions. 16 | include_ext = ["go", "tpl", "tmpl", "html"] 17 | # Ignore these filename extensions or directories. 18 | exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"] 19 | # Watch these directories if you specified. 20 | include_dir = [] 21 | # Watch these files. 22 | include_file = [] 23 | # Exclude files. 24 | exclude_file = [] 25 | # Exclude specific regular expressions. 26 | exclude_regex = ["_test\\.go"] 27 | # Exclude unchanged files. 28 | exclude_unchanged = true 29 | # Follow symlink for directories 30 | follow_symlink = true 31 | # This log file places in your tmp_dir. 32 | log = "air.log" 33 | # It's not necessary to trigger build each time file changes if it's too frequent. 34 | delay = 0 # ms 35 | # Stop running old binary when build errors occur. 36 | stop_on_error = true 37 | # Send Interrupt signal before killing process (windows does not support this feature) 38 | send_interrupt = false 39 | # Delay after sending Interrupt signal 40 | kill_delay = 500 # ms 41 | # Add additional arguments when running binary (bin/full_bin). Will run './tmp/main hello world'. 42 | args_bin = [] 43 | 44 | [log] 45 | # Show log time 46 | time = false 47 | 48 | [color] 49 | # Customize each part's color. If no color found, use the raw app log. 50 | main = "magenta" 51 | watcher = "cyan" 52 | build = "yellow" 53 | runner = "green" 54 | 55 | [misc] 56 | # Delete tmp directory on exit 57 | clean_on_exit = true 58 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_set.yaml: -------------------------------------------------------------------------------- 1 | name: set 2 | synopsis: Set specific features on objects 3 | description: |- 4 | Configure objects. 5 | 6 | These commands help you make changes to existing objects. 7 | inheritedOptions: 8 | - name: iamconfig 9 | usage: Path to the iamconfig file to use for CLI requests 10 | - name: match-server-version 11 | defaultValue: "false" 12 | usage: Require server version to match client version 13 | - name: profile 14 | defaultValue: none 15 | usage: | 16 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 17 | - name: profile-output 18 | defaultValue: profile.pprof 19 | usage: Name of the file to write the profile to 20 | - name: server.address 21 | shorthand: s 22 | usage: The address and port of the IAM API server 23 | - name: server.certificate-authority 24 | usage: Path to a cert file for the certificate authority 25 | - name: server.insecure-skip-tls-verify 26 | defaultValue: "false" 27 | usage: | 28 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 29 | - name: server.max-retries 30 | defaultValue: "0" 31 | usage: Maximum number of retries. 32 | - name: server.retry-interval 33 | defaultValue: 1s 34 | usage: The interval time between each attempt. 35 | - name: server.timeout 36 | defaultValue: 30s 37 | usage: | 38 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 39 | - name: server.tls-server-name 40 | usage: | 41 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 42 | - name: user.client-certificate 43 | usage: Path to a client certificate file for TLS 44 | - name: user.client-key 45 | usage: Path to a client key file for TLS 46 | - name: user.password 47 | usage: Password for basic authentication to the API server 48 | - name: user.secret-id 49 | usage: SecretID for JWT authentication to the API server 50 | - name: user.secret-key 51 | usage: SecretKey for jwt authentication to the API server 52 | - name: user.token 53 | usage: Bearer token for authentication to the API server 54 | - name: user.username 55 | usage: Username for basic authentication to the API server 56 | seeAlso: 57 | - projctl 58 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_info.yaml: -------------------------------------------------------------------------------- 1 | name: info 2 | synopsis: Print the host information 3 | description: Print the host information. 4 | inheritedOptions: 5 | - name: iamconfig 6 | usage: Path to the iamconfig file to use for CLI requests 7 | - name: match-server-version 8 | defaultValue: "false" 9 | usage: Require server version to match client version 10 | - name: profile 11 | defaultValue: none 12 | usage: | 13 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 14 | - name: profile-output 15 | defaultValue: profile.pprof 16 | usage: Name of the file to write the profile to 17 | - name: server.address 18 | shorthand: s 19 | usage: The address and port of the IAM API server 20 | - name: server.certificate-authority 21 | usage: Path to a cert file for the certificate authority 22 | - name: server.insecure-skip-tls-verify 23 | defaultValue: "false" 24 | usage: | 25 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 26 | - name: server.max-retries 27 | defaultValue: "0" 28 | usage: Maximum number of retries. 29 | - name: server.retry-interval 30 | defaultValue: 1s 31 | usage: The interval time between each attempt. 32 | - name: server.timeout 33 | defaultValue: 30s 34 | usage: | 35 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 36 | - name: server.tls-server-name 37 | usage: | 38 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 39 | - name: user.client-certificate 40 | usage: Path to a client certificate file for TLS 41 | - name: user.client-key 42 | usage: Path to a client key file for TLS 43 | - name: user.password 44 | usage: Password for basic authentication to the API server 45 | - name: user.secret-id 46 | usage: SecretID for JWT authentication to the API server 47 | - name: user.secret-key 48 | usage: SecretKey for jwt authentication to the API server 49 | - name: user.token 50 | usage: Bearer token for authentication to the API server 51 | - name: user.username 52 | usage: Username for basic authentication to the API server 53 | example: |4- 54 | # Print the host information 55 | projctl info 56 | seeAlso: 57 | - projctl 58 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_jwt.yaml: -------------------------------------------------------------------------------- 1 | name: jwt 2 | synopsis: JWT command-line tool 3 | description: |- 4 | JWT command. 5 | 6 | This commands is used to sigin/show/verify jwt token. 7 | inheritedOptions: 8 | - name: iamconfig 9 | usage: Path to the iamconfig file to use for CLI requests 10 | - name: match-server-version 11 | defaultValue: "false" 12 | usage: Require server version to match client version 13 | - name: profile 14 | defaultValue: none 15 | usage: | 16 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 17 | - name: profile-output 18 | defaultValue: profile.pprof 19 | usage: Name of the file to write the profile to 20 | - name: server.address 21 | shorthand: s 22 | usage: The address and port of the IAM API server 23 | - name: server.certificate-authority 24 | usage: Path to a cert file for the certificate authority 25 | - name: server.insecure-skip-tls-verify 26 | defaultValue: "false" 27 | usage: | 28 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 29 | - name: server.max-retries 30 | defaultValue: "0" 31 | usage: Maximum number of retries. 32 | - name: server.retry-interval 33 | defaultValue: 1s 34 | usage: The interval time between each attempt. 35 | - name: server.timeout 36 | defaultValue: 30s 37 | usage: | 38 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 39 | - name: server.tls-server-name 40 | usage: | 41 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 42 | - name: user.client-certificate 43 | usage: Path to a client certificate file for TLS 44 | - name: user.client-key 45 | usage: Path to a client key file for TLS 46 | - name: user.password 47 | usage: Password for basic authentication to the API server 48 | - name: user.secret-id 49 | usage: SecretID for JWT authentication to the API server 50 | - name: user.secret-key 51 | usage: SecretKey for jwt authentication to the API server 52 | - name: user.token 53 | usage: Bearer token for authentication to the API server 54 | - name: user.username 55 | usage: Username for basic authentication to the API server 56 | seeAlso: 57 | - projctl 58 | - show 59 | - sign 60 | - verify 61 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_options.yaml: -------------------------------------------------------------------------------- 1 | name: options 2 | synopsis: Print the list of flags inherited by all commands 3 | description: Print the list of flags inherited by all commands 4 | inheritedOptions: 5 | - name: iamconfig 6 | usage: Path to the iamconfig file to use for CLI requests 7 | - name: match-server-version 8 | defaultValue: "false" 9 | usage: Require server version to match client version 10 | - name: profile 11 | defaultValue: none 12 | usage: | 13 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 14 | - name: profile-output 15 | defaultValue: profile.pprof 16 | usage: Name of the file to write the profile to 17 | - name: server.address 18 | shorthand: s 19 | usage: The address and port of the IAM API server 20 | - name: server.certificate-authority 21 | usage: Path to a cert file for the certificate authority 22 | - name: server.insecure-skip-tls-verify 23 | defaultValue: "false" 24 | usage: | 25 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 26 | - name: server.max-retries 27 | defaultValue: "0" 28 | usage: Maximum number of retries. 29 | - name: server.retry-interval 30 | defaultValue: 1s 31 | usage: The interval time between each attempt. 32 | - name: server.timeout 33 | defaultValue: 30s 34 | usage: | 35 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 36 | - name: server.tls-server-name 37 | usage: | 38 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 39 | - name: user.client-certificate 40 | usage: Path to a client certificate file for TLS 41 | - name: user.client-key 42 | usage: Path to a client key file for TLS 43 | - name: user.password 44 | usage: Password for basic authentication to the API server 45 | - name: user.secret-id 46 | usage: SecretID for JWT authentication to the API server 47 | - name: user.secret-key 48 | usage: SecretKey for jwt authentication to the API server 49 | - name: user.token 50 | usage: Bearer token for authentication to the API server 51 | - name: user.username 52 | usage: Username for basic authentication to the API server 53 | example: |4- 54 | # Print flags inherited by all commands 55 | projctl options 56 | seeAlso: 57 | - projctl 58 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_validate.yaml: -------------------------------------------------------------------------------- 1 | name: validate 2 | synopsis: Validate the basic environment for projctl to run 3 | description: Validate the basic environment for projctl to run. 4 | inheritedOptions: 5 | - name: iamconfig 6 | usage: Path to the iamconfig file to use for CLI requests 7 | - name: match-server-version 8 | defaultValue: "false" 9 | usage: Require server version to match client version 10 | - name: profile 11 | defaultValue: none 12 | usage: | 13 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 14 | - name: profile-output 15 | defaultValue: profile.pprof 16 | usage: Name of the file to write the profile to 17 | - name: server.address 18 | shorthand: s 19 | usage: The address and port of the IAM API server 20 | - name: server.certificate-authority 21 | usage: Path to a cert file for the certificate authority 22 | - name: server.insecure-skip-tls-verify 23 | defaultValue: "false" 24 | usage: | 25 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 26 | - name: server.max-retries 27 | defaultValue: "0" 28 | usage: Maximum number of retries. 29 | - name: server.retry-interval 30 | defaultValue: 1s 31 | usage: The interval time between each attempt. 32 | - name: server.timeout 33 | defaultValue: 30s 34 | usage: | 35 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 36 | - name: server.tls-server-name 37 | usage: | 38 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 39 | - name: user.client-certificate 40 | usage: Path to a client certificate file for TLS 41 | - name: user.client-key 42 | usage: Path to a client key file for TLS 43 | - name: user.password 44 | usage: Password for basic authentication to the API server 45 | - name: user.secret-id 46 | usage: SecretID for JWT authentication to the API server 47 | - name: user.secret-key 48 | usage: SecretKey for jwt authentication to the API server 49 | - name: user.token 50 | usage: Bearer token for authentication to the API server 51 | - name: user.username 52 | usage: Username for basic authentication to the API server 53 | example: |4- 54 | # Validate the basic environment for projctl to run 55 | projctl validate 56 | seeAlso: 57 | - projctl 58 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_secret.yaml: -------------------------------------------------------------------------------- 1 | name: secret 2 | synopsis: Manage secrets on iam platform 3 | description: |- 4 | Secret management commands. 5 | 6 | This commands allow you to manage your secret on iam platform. 7 | inheritedOptions: 8 | - name: iamconfig 9 | usage: Path to the iamconfig file to use for CLI requests 10 | - name: match-server-version 11 | defaultValue: "false" 12 | usage: Require server version to match client version 13 | - name: profile 14 | defaultValue: none 15 | usage: | 16 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 17 | - name: profile-output 18 | defaultValue: profile.pprof 19 | usage: Name of the file to write the profile to 20 | - name: server.address 21 | shorthand: s 22 | usage: The address and port of the IAM API server 23 | - name: server.certificate-authority 24 | usage: Path to a cert file for the certificate authority 25 | - name: server.insecure-skip-tls-verify 26 | defaultValue: "false" 27 | usage: | 28 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 29 | - name: server.max-retries 30 | defaultValue: "0" 31 | usage: Maximum number of retries. 32 | - name: server.retry-interval 33 | defaultValue: 1s 34 | usage: The interval time between each attempt. 35 | - name: server.timeout 36 | defaultValue: 30s 37 | usage: | 38 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 39 | - name: server.tls-server-name 40 | usage: | 41 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 42 | - name: user.client-certificate 43 | usage: Path to a client certificate file for TLS 44 | - name: user.client-key 45 | usage: Path to a client key file for TLS 46 | - name: user.password 47 | usage: Password for basic authentication to the API server 48 | - name: user.secret-id 49 | usage: SecretID for JWT authentication to the API server 50 | - name: user.secret-key 51 | usage: SecretKey for jwt authentication to the API server 52 | - name: user.token 53 | usage: Bearer token for authentication to the API server 54 | - name: user.username 55 | usage: Username for basic authentication to the API server 56 | seeAlso: 57 | - projctl 58 | - create 59 | - delete 60 | - get 61 | - list 62 | - update 63 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_policy.yaml: -------------------------------------------------------------------------------- 1 | name: policy 2 | synopsis: Manage authorization policies on iam platform 3 | description: |- 4 | Authorization policy management commands. 5 | 6 | This commands allow you to manage your authorization policy on iam platform. 7 | inheritedOptions: 8 | - name: iamconfig 9 | usage: Path to the iamconfig file to use for CLI requests 10 | - name: match-server-version 11 | defaultValue: "false" 12 | usage: Require server version to match client version 13 | - name: profile 14 | defaultValue: none 15 | usage: | 16 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 17 | - name: profile-output 18 | defaultValue: profile.pprof 19 | usage: Name of the file to write the profile to 20 | - name: server.address 21 | shorthand: s 22 | usage: The address and port of the IAM API server 23 | - name: server.certificate-authority 24 | usage: Path to a cert file for the certificate authority 25 | - name: server.insecure-skip-tls-verify 26 | defaultValue: "false" 27 | usage: | 28 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 29 | - name: server.max-retries 30 | defaultValue: "0" 31 | usage: Maximum number of retries. 32 | - name: server.retry-interval 33 | defaultValue: 1s 34 | usage: The interval time between each attempt. 35 | - name: server.timeout 36 | defaultValue: 30s 37 | usage: | 38 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 39 | - name: server.tls-server-name 40 | usage: | 41 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 42 | - name: user.client-certificate 43 | usage: Path to a client certificate file for TLS 44 | - name: user.client-key 45 | usage: Path to a client key file for TLS 46 | - name: user.password 47 | usage: Password for basic authentication to the API server 48 | - name: user.secret-id 49 | usage: SecretID for JWT authentication to the API server 50 | - name: user.secret-key 51 | usage: SecretKey for jwt authentication to the API server 52 | - name: user.token 53 | usage: Bearer token for authentication to the API server 54 | - name: user.username 55 | usage: Username for basic authentication to the API server 56 | seeAlso: 57 | - projctl 58 | - create 59 | - delete 60 | - get 61 | - list 62 | - update 63 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_user.yaml: -------------------------------------------------------------------------------- 1 | name: user 2 | synopsis: Manage users on iam platform 3 | description: "User management commands.\n \n Administrator can use all subcommands, non-administrator only allow to use create/get/upate. When call get/update non-administrator only allow to operate their own resources, if permission not allowed, will return an 'Permission denied' error." 4 | inheritedOptions: 5 | - name: iamconfig 6 | usage: Path to the iamconfig file to use for CLI requests 7 | - name: match-server-version 8 | defaultValue: "false" 9 | usage: Require server version to match client version 10 | - name: profile 11 | defaultValue: none 12 | usage: | 13 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 14 | - name: profile-output 15 | defaultValue: profile.pprof 16 | usage: Name of the file to write the profile to 17 | - name: server.address 18 | shorthand: s 19 | usage: The address and port of the IAM API server 20 | - name: server.certificate-authority 21 | usage: Path to a cert file for the certificate authority 22 | - name: server.insecure-skip-tls-verify 23 | defaultValue: "false" 24 | usage: | 25 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 26 | - name: server.max-retries 27 | defaultValue: "0" 28 | usage: Maximum number of retries. 29 | - name: server.retry-interval 30 | defaultValue: 1s 31 | usage: The interval time between each attempt. 32 | - name: server.timeout 33 | defaultValue: 30s 34 | usage: | 35 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 36 | - name: server.tls-server-name 37 | usage: | 38 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 39 | - name: user.client-certificate 40 | usage: Path to a client certificate file for TLS 41 | - name: user.client-key 42 | usage: Path to a client key file for TLS 43 | - name: user.password 44 | usage: Password for basic authentication to the API server 45 | - name: user.secret-id 46 | usage: SecretID for JWT authentication to the API server 47 | - name: user.secret-key 48 | usage: SecretKey for jwt authentication to the API server 49 | - name: user.token 50 | usage: Bearer token for authentication to the API server 51 | - name: user.username 52 | usage: Username for basic authentication to the API server 53 | seeAlso: 54 | - projctl 55 | - create 56 | - delete 57 | - get 58 | - list 59 | - update 60 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl.yaml: -------------------------------------------------------------------------------- 1 | name: projctl 2 | synopsis: projctl controls the superproj platform 3 | description: |- 4 | projctl controls the superproj platform, is the client side tool for superproj platform. 5 | 6 | Find more information at: https://github.com/superproj/superproj/blob/master/docs/guide/en-US/cmd/projctl/projctl.md 7 | options: 8 | - name: iamconfig 9 | usage: Path to the iamconfig file to use for CLI requests 10 | - name: match-server-version 11 | defaultValue: "false" 12 | usage: Require server version to match client version 13 | - name: profile 14 | defaultValue: none 15 | usage: | 16 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 17 | - name: profile-output 18 | defaultValue: profile.pprof 19 | usage: Name of the file to write the profile to 20 | - name: server.address 21 | shorthand: s 22 | usage: The address and port of the IAM API server 23 | - name: server.certificate-authority 24 | usage: Path to a cert file for the certificate authority 25 | - name: server.insecure-skip-tls-verify 26 | defaultValue: "false" 27 | usage: | 28 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 29 | - name: server.max-retries 30 | defaultValue: "0" 31 | usage: Maximum number of retries. 32 | - name: server.retry-interval 33 | defaultValue: 1s 34 | usage: The interval time between each attempt. 35 | - name: server.timeout 36 | defaultValue: 30s 37 | usage: | 38 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 39 | - name: server.tls-server-name 40 | usage: | 41 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 42 | - name: user.client-certificate 43 | usage: Path to a client certificate file for TLS 44 | - name: user.client-key 45 | usage: Path to a client key file for TLS 46 | - name: user.password 47 | usage: Password for basic authentication to the API server 48 | - name: user.secret-id 49 | usage: SecretID for JWT authentication to the API server 50 | - name: user.secret-key 51 | usage: SecretKey for jwt authentication to the API server 52 | - name: user.token 53 | usage: Bearer token for authentication to the API server 54 | - name: user.username 55 | usage: Username for basic authentication to the API server 56 | seeAlso: 57 | - color 58 | - completion 59 | - info 60 | - jwt 61 | - new 62 | - options 63 | - policy 64 | - secret 65 | - set 66 | - user 67 | - validate 68 | - version 69 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_version.yaml: -------------------------------------------------------------------------------- 1 | name: version 2 | synopsis: Print the client and server version information 3 | description: | 4 | Print the client and server version information for the current context 5 | options: 6 | - name: client 7 | defaultValue: "false" 8 | usage: If true, shows client version only (no server required). 9 | - name: output 10 | shorthand: o 11 | usage: One of 'yaml' or 'json'. 12 | - name: short 13 | defaultValue: "false" 14 | usage: If true, print just the version number. 15 | inheritedOptions: 16 | - name: iamconfig 17 | usage: Path to the iamconfig file to use for CLI requests 18 | - name: match-server-version 19 | defaultValue: "false" 20 | usage: Require server version to match client version 21 | - name: profile 22 | defaultValue: none 23 | usage: | 24 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 25 | - name: profile-output 26 | defaultValue: profile.pprof 27 | usage: Name of the file to write the profile to 28 | - name: server.address 29 | shorthand: s 30 | usage: The address and port of the IAM API server 31 | - name: server.certificate-authority 32 | usage: Path to a cert file for the certificate authority 33 | - name: server.insecure-skip-tls-verify 34 | defaultValue: "false" 35 | usage: | 36 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 37 | - name: server.max-retries 38 | defaultValue: "0" 39 | usage: Maximum number of retries. 40 | - name: server.retry-interval 41 | defaultValue: 1s 42 | usage: The interval time between each attempt. 43 | - name: server.timeout 44 | defaultValue: 30s 45 | usage: | 46 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 47 | - name: server.tls-server-name 48 | usage: | 49 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 50 | - name: user.client-certificate 51 | usage: Path to a client certificate file for TLS 52 | - name: user.client-key 53 | usage: Path to a client key file for TLS 54 | - name: user.password 55 | usage: Password for basic authentication to the API server 56 | - name: user.secret-id 57 | usage: SecretID for JWT authentication to the API server 58 | - name: user.secret-key 59 | usage: SecretKey for jwt authentication to the API server 60 | - name: user.token 61 | usage: Bearer token for authentication to the API server 62 | - name: user.username 63 | usage: Username for basic authentication to the API server 64 | example: |4- 65 | # Print the client and server versions for the current context 66 | projctl version 67 | seeAlso: 68 | - projctl 69 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_color.yaml: -------------------------------------------------------------------------------- 1 | name: color 2 | synopsis: Print colors supported by the current terminal 3 | description: |- 4 | Print the colors supported by the current terminal. 5 | 6 | Color lets you use colorized outputs in terms of ANSI Escape Codes in Go (Golang). It has support for Windows too! The API can be used in several ways, pick one that suits you. 7 | 8 | Find more information at: https://github.com/fatih/color 9 | options: 10 | - name: example 11 | defaultValue: "false" 12 | usage: Print code to show how to use color package. 13 | - name: type 14 | shorthand: t 15 | defaultValue: '[]' 16 | usage: | 17 | Specify the color type, available types: `fg,fg-hi,bg,bg-hi,base,all`. 18 | inheritedOptions: 19 | - name: iamconfig 20 | usage: Path to the iamconfig file to use for CLI requests 21 | - name: match-server-version 22 | defaultValue: "false" 23 | usage: Require server version to match client version 24 | - name: profile 25 | defaultValue: none 26 | usage: | 27 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 28 | - name: profile-output 29 | defaultValue: profile.pprof 30 | usage: Name of the file to write the profile to 31 | - name: server.address 32 | shorthand: s 33 | usage: The address and port of the IAM API server 34 | - name: server.certificate-authority 35 | usage: Path to a cert file for the certificate authority 36 | - name: server.insecure-skip-tls-verify 37 | defaultValue: "false" 38 | usage: | 39 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 40 | - name: server.max-retries 41 | defaultValue: "0" 42 | usage: Maximum number of retries. 43 | - name: server.retry-interval 44 | defaultValue: 1s 45 | usage: The interval time between each attempt. 46 | - name: server.timeout 47 | defaultValue: 30s 48 | usage: | 49 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 50 | - name: server.tls-server-name 51 | usage: | 52 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 53 | - name: user.client-certificate 54 | usage: Path to a client certificate file for TLS 55 | - name: user.client-key 56 | usage: Path to a client key file for TLS 57 | - name: user.password 58 | usage: Password for basic authentication to the API server 59 | - name: user.secret-id 60 | usage: SecretID for JWT authentication to the API server 61 | - name: user.secret-key 62 | usage: SecretKey for jwt authentication to the API server 63 | - name: user.token 64 | usage: Bearer token for authentication to the API server 65 | - name: user.username 66 | usage: Username for basic authentication to the API server 67 | example: " # Print supported foreground and background colors\n projctl color\n \n # Print supported colors by type\n projctl color -t fg-hi\n \n # Print all supported colors\n projctl color -t all" 68 | seeAlso: 69 | - projctl 70 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_new.yaml: -------------------------------------------------------------------------------- 1 | name: new 2 | synopsis: Generate demo command code 3 | description: |- 4 | Used to generate demo command source code file. 5 | 6 | Can use this command generate a command template file, and do some modify based on your needs. This can improve your R &D efficiency. 7 | options: 8 | - name: group 9 | shorthand: g 10 | defaultValue: "false" 11 | usage: Generate two subcommands. 12 | - name: outdir 13 | shorthand: d 14 | defaultValue: . 15 | usage: Where to create demo command files. 16 | inheritedOptions: 17 | - name: iamconfig 18 | usage: Path to the iamconfig file to use for CLI requests 19 | - name: match-server-version 20 | defaultValue: "false" 21 | usage: Require server version to match client version 22 | - name: profile 23 | defaultValue: none 24 | usage: | 25 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 26 | - name: profile-output 27 | defaultValue: profile.pprof 28 | usage: Name of the file to write the profile to 29 | - name: server.address 30 | shorthand: s 31 | usage: The address and port of the IAM API server 32 | - name: server.certificate-authority 33 | usage: Path to a cert file for the certificate authority 34 | - name: server.insecure-skip-tls-verify 35 | defaultValue: "false" 36 | usage: | 37 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 38 | - name: server.max-retries 39 | defaultValue: "0" 40 | usage: Maximum number of retries. 41 | - name: server.retry-interval 42 | defaultValue: 1s 43 | usage: The interval time between each attempt. 44 | - name: server.timeout 45 | defaultValue: 30s 46 | usage: | 47 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 48 | - name: server.tls-server-name 49 | usage: | 50 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 51 | - name: user.client-certificate 52 | usage: Path to a client certificate file for TLS 53 | - name: user.client-key 54 | usage: Path to a client key file for TLS 55 | - name: user.password 56 | usage: Password for basic authentication to the API server 57 | - name: user.secret-id 58 | usage: SecretID for JWT authentication to the API server 59 | - name: user.secret-key 60 | usage: SecretKey for jwt authentication to the API server 61 | - name: user.token 62 | usage: Bearer token for authentication to the API server 63 | - name: user.username 64 | usage: Username for basic authentication to the API server 65 | example: " # Create a default 'test' command file without a description\n projctl new test\n \n # Create a default 'test' command file in /tmp/\n projctl new test -d /tmp/\n \n # Create a default 'test' command file with a description\n projctl new test \"This is a test command\"\n \n # Create command 'test' with two subcommands\n projctl new -g test \"This is a test command with two subcommands\"" 66 | seeAlso: 67 | - projctl 68 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_set.md: -------------------------------------------------------------------------------- 1 | ## projctl set 2 | 3 | Set specific features on objects 4 | 5 | ### Synopsis 6 | 7 | Configure objects. 8 | 9 | These commands help you make changes to existing objects. 10 | 11 | ``` 12 | projctl set SUBCOMMAND 13 | ``` 14 | 15 | ### Options 16 | 17 | ``` 18 | -h, --help help for set 19 | ``` 20 | 21 | ### Options inherited from parent commands 22 | 23 | ``` 24 | --alsologtostderr log to standard error as well as files 25 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 26 | --iamconfig string Path to the iamconfig file to use for CLI requests 27 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 28 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 29 | --log-dir string If non-empty, write log files in this directory 30 | --logtostderr log to standard error instead of files 31 | --match-server-version Require server version to match client version 32 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 33 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 34 | -s, --server.address string The address and port of the IAM API server 35 | --server.certificate-authority string Path to a cert file for the certificate authority 36 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 37 | --server.max-retries int Maximum number of retries. 38 | --server.retry-interval duration The interval time between each attempt. (default 1s) 39 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 40 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 41 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 42 | --user.client-certificate string Path to a client certificate file for TLS 43 | --user.client-key string Path to a client key file for TLS 44 | --user.password string Password for basic authentication to the API server 45 | --user.secret-id string SecretID for JWT authentication to the API server 46 | --user.secret-key string SecretKey for jwt authentication to the API server 47 | --user.token string Bearer token for authentication to the API server 48 | --user.username string Username for basic authentication to the API server 49 | -v, --v Level log level for V logs 50 | --version version[=true] Print version information and quit 51 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 52 | ``` 53 | 54 | ### SEE ALSO 55 | 56 | * [projctl](projctl.md) - projctl controls the superproj platform 57 | 58 | ###### Auto generated by spf13/cobra on 29-Oct-2022 59 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_info.md: -------------------------------------------------------------------------------- 1 | ## projctl info 2 | 3 | Print the host information 4 | 5 | ### Synopsis 6 | 7 | Print the host information. 8 | 9 | ``` 10 | projctl info 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Print the host information 17 | projctl info 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for info 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl](projctl.md) - projctl controls the superproj platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_user_get.md: -------------------------------------------------------------------------------- 1 | ## projctl user get 2 | 3 | Display a user resource. 4 | 5 | ### Synopsis 6 | 7 | Display a user resource. 8 | 9 | ``` 10 | projctl user get USERNAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Get user foo detail information 17 | projctl user get foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for get 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl user](projctl_user.md) - Manage users on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret_delete.md: -------------------------------------------------------------------------------- 1 | ## projctl secret delete 2 | 3 | Delete a secret resource 4 | 5 | ### Synopsis 6 | 7 | Delete a secret resource. 8 | 9 | ``` 10 | projctl secret delete SECRET_NAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Delete secret foo 17 | projctl secret delete foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for delete 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl secret](projctl_secret.md) - Manage secrets on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret_get.md: -------------------------------------------------------------------------------- 1 | ## projctl secret get 2 | 3 | Display a secret resource 4 | 5 | ### Synopsis 6 | 7 | Display a secret resource. 8 | 9 | ``` 10 | projctl secret get SECRET_NAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Get a specified secret information 17 | projctl secret get foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for get 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl secret](projctl_secret.md) - Manage secrets on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_options.md: -------------------------------------------------------------------------------- 1 | ## projctl options 2 | 3 | Print the list of flags inherited by all commands 4 | 5 | ### Synopsis 6 | 7 | Print the list of flags inherited by all commands 8 | 9 | ``` 10 | projctl options [flags] 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Print flags inherited by all commands 17 | projctl options 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for options 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl](projctl.md) - projctl controls the superproj platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy_delete.md: -------------------------------------------------------------------------------- 1 | ## projctl policy delete 2 | 3 | Delete a authorization policy resource 4 | 5 | ### Synopsis 6 | 7 | Delete a authorization policy resource. 8 | 9 | ``` 10 | projctl policy delete 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Delete a policy resource 17 | projctl policy delete foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for delete 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl policy](projctl_policy.md) - Manage authorization policies on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy_get.md: -------------------------------------------------------------------------------- 1 | ## projctl policy get 2 | 3 | Display a authorization policy resource 4 | 5 | ### Synopsis 6 | 7 | Display a authorization policy resource. 8 | 9 | ``` 10 | projctl policy get POLICY_NAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Display a policy resource 17 | projctl policy get foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for get 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl policy](projctl_policy.md) - Manage authorization policies on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_validate.md: -------------------------------------------------------------------------------- 1 | ## projctl validate 2 | 3 | Validate the basic environment for projctl to run 4 | 5 | ### Synopsis 6 | 7 | Validate the basic environment for projctl to run. 8 | 9 | ``` 10 | projctl validate 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Validate the basic environment for projctl to run 17 | projctl validate 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for validate 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl](projctl.md) - projctl controls the superproj platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_jwt_show.md: -------------------------------------------------------------------------------- 1 | ## projctl jwt show 2 | 3 | Show header and claims for a JWT token 4 | 5 | ### Synopsis 6 | 7 | Show header and claims for a JWT token 8 | 9 | ``` 10 | projctl jwt show TOKEN 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Show header and Claims for a JWT token 17 | projctl jwt show XXX.XXX.XXX 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | --compact output compact JSON. 24 | -h, --help help for show 25 | ``` 26 | 27 | ### Options inherited from parent commands 28 | 29 | ``` 30 | --alsologtostderr log to standard error as well as files 31 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | --iamconfig string Path to the iamconfig file to use for CLI requests 33 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 34 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 35 | --log-dir string If non-empty, write log files in this directory 36 | --logtostderr log to standard error instead of files 37 | --match-server-version Require server version to match client version 38 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 39 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 40 | -s, --server.address string The address and port of the IAM API server 41 | --server.certificate-authority string Path to a cert file for the certificate authority 42 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 43 | --server.max-retries int Maximum number of retries. 44 | --server.retry-interval duration The interval time between each attempt. (default 1s) 45 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 46 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 47 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 48 | --user.client-certificate string Path to a client certificate file for TLS 49 | --user.client-key string Path to a client key file for TLS 50 | --user.password string Password for basic authentication to the API server 51 | --user.secret-id string SecretID for JWT authentication to the API server 52 | --user.secret-key string SecretKey for jwt authentication to the API server 53 | --user.token string Bearer token for authentication to the API server 54 | --user.username string Username for basic authentication to the API server 55 | -v, --v Level log level for V logs 56 | --version version[=true] Print version information and quit 57 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 58 | ``` 59 | 60 | ### SEE ALSO 61 | 62 | * [projctl jwt](projctl_jwt.md) - JWT command-line tool 63 | 64 | ###### Auto generated by spf13/cobra on 29-Oct-2022 65 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_jwt_verify.md: -------------------------------------------------------------------------------- 1 | ## projctl jwt verify 2 | 3 | Verify a JWT token 4 | 5 | ### Synopsis 6 | 7 | Verify a JWT token 8 | 9 | ``` 10 | projctl jwt verify 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Verify a JWT token 17 | projctl jwt verify XXX xxxxx.yyyyy.zzzzz 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | --compact Output compact JSON. 24 | --debug Print out all kinds of debug data. 25 | -h, --help help for verify 26 | ``` 27 | 28 | ### Options inherited from parent commands 29 | 30 | ``` 31 | --alsologtostderr log to standard error as well as files 32 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 33 | --iamconfig string Path to the iamconfig file to use for CLI requests 34 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 35 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 36 | --log-dir string If non-empty, write log files in this directory 37 | --logtostderr log to standard error instead of files 38 | --match-server-version Require server version to match client version 39 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 40 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 41 | -s, --server.address string The address and port of the IAM API server 42 | --server.certificate-authority string Path to a cert file for the certificate authority 43 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 44 | --server.max-retries int Maximum number of retries. 45 | --server.retry-interval duration The interval time between each attempt. (default 1s) 46 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 47 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 48 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 49 | --user.client-certificate string Path to a client certificate file for TLS 50 | --user.client-key string Path to a client key file for TLS 51 | --user.password string Password for basic authentication to the API server 52 | --user.secret-id string SecretID for JWT authentication to the API server 53 | --user.secret-key string SecretKey for jwt authentication to the API server 54 | --user.token string Bearer token for authentication to the API server 55 | --user.username string Username for basic authentication to the API server 56 | -v, --v Level log level for V logs 57 | --version version[=true] Print version information and quit 58 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 59 | ``` 60 | 61 | ### SEE ALSO 62 | 63 | * [projctl jwt](projctl_jwt.md) - JWT command-line tool 64 | 65 | ###### Auto generated by spf13/cobra on 29-Oct-2022 66 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_user_delete.md: -------------------------------------------------------------------------------- 1 | ## projctl user delete 2 | 3 | Delete a user resource from iam platform (Administrator rights required) 4 | 5 | ### Synopsis 6 | 7 | Delete a user resource from iam platform, only administrator can do this operation. 8 | 9 | ``` 10 | projctl user delete USERNAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Delete user foo from platform 17 | projctl user delete foo 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for delete 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl user](projctl_user.md) - Manage users on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_jwt.md: -------------------------------------------------------------------------------- 1 | ## projctl jwt 2 | 3 | JWT command-line tool 4 | 5 | ### Synopsis 6 | 7 | JWT command. 8 | 9 | This commands is used to sigin/show/verify jwt token. 10 | 11 | ``` 12 | projctl jwt SUBCOMMAND 13 | ``` 14 | 15 | ### Options 16 | 17 | ``` 18 | -h, --help help for jwt 19 | ``` 20 | 21 | ### Options inherited from parent commands 22 | 23 | ``` 24 | --alsologtostderr log to standard error as well as files 25 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 26 | --iamconfig string Path to the iamconfig file to use for CLI requests 27 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 28 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 29 | --log-dir string If non-empty, write log files in this directory 30 | --logtostderr log to standard error instead of files 31 | --match-server-version Require server version to match client version 32 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 33 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 34 | -s, --server.address string The address and port of the IAM API server 35 | --server.certificate-authority string Path to a cert file for the certificate authority 36 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 37 | --server.max-retries int Maximum number of retries. 38 | --server.retry-interval duration The interval time between each attempt. (default 1s) 39 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 40 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 41 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 42 | --user.client-certificate string Path to a client certificate file for TLS 43 | --user.client-key string Path to a client key file for TLS 44 | --user.password string Password for basic authentication to the API server 45 | --user.secret-id string SecretID for JWT authentication to the API server 46 | --user.secret-key string SecretKey for jwt authentication to the API server 47 | --user.token string Bearer token for authentication to the API server 48 | --user.username string Username for basic authentication to the API server 49 | -v, --v Level log level for V logs 50 | --version version[=true] Print version information and quit 51 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 52 | ``` 53 | 54 | ### SEE ALSO 55 | 56 | * [projctl](projctl.md) - projctl controls the superproj platform 57 | * [projctl jwt show](projctl_jwt_show.md) - Show header and claims for a JWT token 58 | * [projctl jwt sign](projctl_jwt_sign.md) - Sign a jwt token with given secretID and secretKey 59 | * [projctl jwt verify](projctl_jwt_verify.md) - Verify a JWT token 60 | 61 | ###### Auto generated by spf13/cobra on 29-Oct-2022 62 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret_update.md: -------------------------------------------------------------------------------- 1 | ## projctl secret update 2 | 3 | Update a secret resource 4 | 5 | ### Synopsis 6 | 7 | Update a secret resource. 8 | 9 | ``` 10 | projctl secret update SECRET_NAME 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Update a secret resource 17 | projctl secret update foo --expires=4h --description="new description" 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | --description string The description of the secret. 24 | --expires int The expires of the secret. 25 | -h, --help help for update 26 | ``` 27 | 28 | ### Options inherited from parent commands 29 | 30 | ``` 31 | --alsologtostderr log to standard error as well as files 32 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 33 | --iamconfig string Path to the iamconfig file to use for CLI requests 34 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 35 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 36 | --log-dir string If non-empty, write log files in this directory 37 | --logtostderr log to standard error instead of files 38 | --match-server-version Require server version to match client version 39 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 40 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 41 | -s, --server.address string The address and port of the IAM API server 42 | --server.certificate-authority string Path to a cert file for the certificate authority 43 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 44 | --server.max-retries int Maximum number of retries. 45 | --server.retry-interval duration The interval time between each attempt. (default 1s) 46 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 47 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 48 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 49 | --user.client-certificate string Path to a client certificate file for TLS 50 | --user.client-key string Path to a client key file for TLS 51 | --user.password string Password for basic authentication to the API server 52 | --user.secret-id string SecretID for JWT authentication to the API server 53 | --user.secret-key string SecretKey for jwt authentication to the API server 54 | --user.token string Bearer token for authentication to the API server 55 | --user.username string Username for basic authentication to the API server 56 | -v, --v Level log level for V logs 57 | --version version[=true] Print version information and quit 58 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 59 | ``` 60 | 61 | ### SEE ALSO 62 | 63 | * [projctl secret](projctl_secret.md) - Manage secrets on iam platform 64 | 65 | ###### Auto generated by spf13/cobra on 29-Oct-2022 66 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-set.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl set - Set specific features on objects 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl set\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Configure objects. 19 | 20 | .PP 21 | These commands help you make changes to existing objects. 22 | 23 | 24 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 25 | .PP 26 | \fB--alsologtostderr\fP=false 27 | log to standard error as well as files 28 | 29 | .PP 30 | \fB-c\fP, \fB--config\fP="" 31 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | 33 | .PP 34 | \fB--iamconfig\fP="" 35 | Path to the iamconfig file to use for CLI requests 36 | 37 | .PP 38 | \fB--kubeconfig\fP="" 39 | Paths to a kubeconfig. Only required if out-of-cluster. 40 | 41 | .PP 42 | \fB--log-backtrace-at\fP=:0 43 | when logging hits line file:N, emit a stack trace 44 | 45 | .PP 46 | \fB--log-dir\fP="" 47 | If non-empty, write log files in this directory 48 | 49 | .PP 50 | \fB--logtostderr\fP=false 51 | log to standard error instead of files 52 | 53 | .PP 54 | \fB--match-server-version\fP=false 55 | Require server version to match client version 56 | 57 | .PP 58 | \fB--profile\fP="none" 59 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 60 | 61 | .PP 62 | \fB--profile-output\fP="profile.pprof" 63 | Name of the file to write the profile to 64 | 65 | .PP 66 | \fB-s\fP, \fB--server.address\fP="" 67 | The address and port of the IAM API server 68 | 69 | .PP 70 | \fB--server.certificate-authority\fP="" 71 | Path to a cert file for the certificate authority 72 | 73 | .PP 74 | \fB--server.insecure-skip-tls-verify\fP=false 75 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 | 77 | .PP 78 | \fB--server.max-retries\fP=0 79 | Maximum number of retries. 80 | 81 | .PP 82 | \fB--server.retry-interval\fP=1s 83 | The interval time between each attempt. 84 | 85 | .PP 86 | \fB--server.timeout\fP=30s 87 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 88 | 89 | .PP 90 | \fB--server.tls-server-name\fP="" 91 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 92 | 93 | .PP 94 | \fB--stderrthreshold\fP=2 95 | logs at or above this threshold go to stderr 96 | 97 | .PP 98 | \fB--user.client-certificate\fP="" 99 | Path to a client certificate file for TLS 100 | 101 | .PP 102 | \fB--user.client-key\fP="" 103 | Path to a client key file for TLS 104 | 105 | .PP 106 | \fB--user.password\fP="" 107 | Password for basic authentication to the API server 108 | 109 | .PP 110 | \fB--user.secret-id\fP="" 111 | SecretID for JWT authentication to the API server 112 | 113 | .PP 114 | \fB--user.secret-key\fP="" 115 | SecretKey for jwt authentication to the API server 116 | 117 | .PP 118 | \fB--user.token\fP="" 119 | Bearer token for authentication to the API server 120 | 121 | .PP 122 | \fB--user.username\fP="" 123 | Username for basic authentication to the API server 124 | 125 | .PP 126 | \fB-v\fP, \fB--v\fP=0 127 | log level for V logs 128 | 129 | .PP 130 | \fB--version\fP=false 131 | Print version information and quit 132 | 133 | .PP 134 | \fB--vmodule\fP= 135 | comma-separated list of pattern=N settings for file-filtered logging 136 | 137 | 138 | .SH SEE ALSO 139 | .PP 140 | \fBprojctl(1)\fP, 141 | 142 | 143 | .SH HISTORY 144 | .PP 145 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 146 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret_list.md: -------------------------------------------------------------------------------- 1 | ## projctl secret list 2 | 3 | Display all secret resources 4 | 5 | ### Synopsis 6 | 7 | Display all secret resources. 8 | 9 | ``` 10 | projctl secret list 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # List all secrets 17 | projctl secret list 18 | 19 | # List secrets with limit and offset 20 | projctl secret list --offset=0 --limit=5 21 | ``` 22 | 23 | ### Options 24 | 25 | ``` 26 | -h, --help help for list 27 | -l, --limit int Specify the amount records to be returned. (default 1000) 28 | -o, --offset int Specify the offset of the first row to be returned. 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --alsologtostderr log to standard error as well as files 35 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 36 | --iamconfig string Path to the iamconfig file to use for CLI requests 37 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 38 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 39 | --log-dir string If non-empty, write log files in this directory 40 | --logtostderr log to standard error instead of files 41 | --match-server-version Require server version to match client version 42 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 43 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 44 | -s, --server.address string The address and port of the IAM API server 45 | --server.certificate-authority string Path to a cert file for the certificate authority 46 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 47 | --server.max-retries int Maximum number of retries. 48 | --server.retry-interval duration The interval time between each attempt. (default 1s) 49 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 50 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 51 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 52 | --user.client-certificate string Path to a client certificate file for TLS 53 | --user.client-key string Path to a client key file for TLS 54 | --user.password string Password for basic authentication to the API server 55 | --user.secret-id string SecretID for JWT authentication to the API server 56 | --user.secret-key string SecretKey for jwt authentication to the API server 57 | --user.token string Bearer token for authentication to the API server 58 | --user.username string Username for basic authentication to the API server 59 | -v, --v Level log level for V logs 60 | --version version[=true] Print version information and quit 61 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 62 | ``` 63 | 64 | ### SEE ALSO 65 | 66 | * [projctl secret](projctl_secret.md) - Manage secrets on iam platform 67 | 68 | ###### Auto generated by spf13/cobra on 29-Oct-2022 69 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-jwt.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl jwt - JWT command-line tool 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl jwt\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | JWT command. 19 | 20 | .PP 21 | This commands is used to sigin/show/verify jwt token. 22 | 23 | 24 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 25 | .PP 26 | \fB--alsologtostderr\fP=false 27 | log to standard error as well as files 28 | 29 | .PP 30 | \fB-c\fP, \fB--config\fP="" 31 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | 33 | .PP 34 | \fB--iamconfig\fP="" 35 | Path to the iamconfig file to use for CLI requests 36 | 37 | .PP 38 | \fB--kubeconfig\fP="" 39 | Paths to a kubeconfig. Only required if out-of-cluster. 40 | 41 | .PP 42 | \fB--log-backtrace-at\fP=:0 43 | when logging hits line file:N, emit a stack trace 44 | 45 | .PP 46 | \fB--log-dir\fP="" 47 | If non-empty, write log files in this directory 48 | 49 | .PP 50 | \fB--logtostderr\fP=false 51 | log to standard error instead of files 52 | 53 | .PP 54 | \fB--match-server-version\fP=false 55 | Require server version to match client version 56 | 57 | .PP 58 | \fB--profile\fP="none" 59 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 60 | 61 | .PP 62 | \fB--profile-output\fP="profile.pprof" 63 | Name of the file to write the profile to 64 | 65 | .PP 66 | \fB-s\fP, \fB--server.address\fP="" 67 | The address and port of the IAM API server 68 | 69 | .PP 70 | \fB--server.certificate-authority\fP="" 71 | Path to a cert file for the certificate authority 72 | 73 | .PP 74 | \fB--server.insecure-skip-tls-verify\fP=false 75 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 | 77 | .PP 78 | \fB--server.max-retries\fP=0 79 | Maximum number of retries. 80 | 81 | .PP 82 | \fB--server.retry-interval\fP=1s 83 | The interval time between each attempt. 84 | 85 | .PP 86 | \fB--server.timeout\fP=30s 87 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 88 | 89 | .PP 90 | \fB--server.tls-server-name\fP="" 91 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 92 | 93 | .PP 94 | \fB--stderrthreshold\fP=2 95 | logs at or above this threshold go to stderr 96 | 97 | .PP 98 | \fB--user.client-certificate\fP="" 99 | Path to a client certificate file for TLS 100 | 101 | .PP 102 | \fB--user.client-key\fP="" 103 | Path to a client key file for TLS 104 | 105 | .PP 106 | \fB--user.password\fP="" 107 | Password for basic authentication to the API server 108 | 109 | .PP 110 | \fB--user.secret-id\fP="" 111 | SecretID for JWT authentication to the API server 112 | 113 | .PP 114 | \fB--user.secret-key\fP="" 115 | SecretKey for jwt authentication to the API server 116 | 117 | .PP 118 | \fB--user.token\fP="" 119 | Bearer token for authentication to the API server 120 | 121 | .PP 122 | \fB--user.username\fP="" 123 | Username for basic authentication to the API server 124 | 125 | .PP 126 | \fB-v\fP, \fB--v\fP=0 127 | log level for V logs 128 | 129 | .PP 130 | \fB--version\fP=false 131 | Print version information and quit 132 | 133 | .PP 134 | \fB--vmodule\fP= 135 | comma-separated list of pattern=N settings for file-filtered logging 136 | 137 | 138 | .SH SEE ALSO 139 | .PP 140 | \fBprojctl(1)\fP, \fBprojctl-jwt-show(1)\fP, \fBprojctl-jwt-sign(1)\fP, \fBprojctl-jwt-verify(1)\fP, 141 | 142 | 143 | .SH HISTORY 144 | .PP 145 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 146 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-info.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl info - Print the host information 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl info\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Print the host information. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Print the host information 141 | projctl info 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_version.md: -------------------------------------------------------------------------------- 1 | ## projctl version 2 | 3 | Print the client and server version information 4 | 5 | ### Synopsis 6 | 7 | Print the client and server version information for the current context 8 | 9 | ``` 10 | projctl version [flags] 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Print the client and server versions for the current context 17 | projctl version 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | --client If true, shows client version only (no server required). 24 | -h, --help help for version 25 | -o, --output string One of 'yaml' or 'json'. 26 | --short If true, print just the version number. 27 | ``` 28 | 29 | ### Options inherited from parent commands 30 | 31 | ``` 32 | --alsologtostderr log to standard error as well as files 33 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 34 | --iamconfig string Path to the iamconfig file to use for CLI requests 35 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 36 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 37 | --log-dir string If non-empty, write log files in this directory 38 | --logtostderr log to standard error instead of files 39 | --match-server-version Require server version to match client version 40 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 41 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 42 | -s, --server.address string The address and port of the IAM API server 43 | --server.certificate-authority string Path to a cert file for the certificate authority 44 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 45 | --server.max-retries int Maximum number of retries. 46 | --server.retry-interval duration The interval time between each attempt. (default 1s) 47 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 48 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 49 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 50 | --user.client-certificate string Path to a client certificate file for TLS 51 | --user.client-key string Path to a client key file for TLS 52 | --user.password string Password for basic authentication to the API server 53 | --user.secret-id string SecretID for JWT authentication to the API server 54 | --user.secret-key string SecretKey for jwt authentication to the API server 55 | --user.token string Bearer token for authentication to the API server 56 | --user.username string Username for basic authentication to the API server 57 | -v, --v Level log level for V logs 58 | --version version[=true] Print version information and quit 59 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 60 | ``` 61 | 62 | ### SEE ALSO 63 | 64 | * [projctl](projctl.md) - projctl controls the superproj platform 65 | 66 | ###### Auto generated by spf13/cobra on 29-Oct-2022 67 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_user_list.md: -------------------------------------------------------------------------------- 1 | ## projctl user list 2 | 3 | Display all users in iam platform (Administrator rights required) 4 | 5 | ### Synopsis 6 | 7 | Display all users in iam platform (Administrator rights required). 8 | 9 | ``` 10 | projctl user list 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # List all users 17 | projctl user list 18 | 19 | # List users with limit and offset 20 | projctl user list --offset=0 --limit=10 21 | ``` 22 | 23 | ### Options 24 | 25 | ``` 26 | -h, --help help for list 27 | -l, --limit int Specify the amount records to be returned. (default 1000) 28 | -o, --offset int Specify the offset of the first row to be returned. 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --alsologtostderr log to standard error as well as files 35 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 36 | --iamconfig string Path to the iamconfig file to use for CLI requests 37 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 38 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 39 | --log-dir string If non-empty, write log files in this directory 40 | --logtostderr log to standard error instead of files 41 | --match-server-version Require server version to match client version 42 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 43 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 44 | -s, --server.address string The address and port of the IAM API server 45 | --server.certificate-authority string Path to a cert file for the certificate authority 46 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 47 | --server.max-retries int Maximum number of retries. 48 | --server.retry-interval duration The interval time between each attempt. (default 1s) 49 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 50 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 51 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 52 | --user.client-certificate string Path to a client certificate file for TLS 53 | --user.client-key string Path to a client key file for TLS 54 | --user.password string Password for basic authentication to the API server 55 | --user.secret-id string SecretID for JWT authentication to the API server 56 | --user.secret-key string SecretKey for jwt authentication to the API server 57 | --user.token string Bearer token for authentication to the API server 58 | --user.username string Username for basic authentication to the API server 59 | -v, --v Level log level for V logs 60 | --version version[=true] Print version information and quit 61 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 62 | ``` 63 | 64 | ### SEE ALSO 65 | 66 | * [projctl user](projctl_user.md) - Manage users on iam platform 67 | 68 | ###### Auto generated by spf13/cobra on 29-Oct-2022 69 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-user-get.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl user get - Display a user resource. 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl user get\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Display a user resource. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Get user foo detail information 141 | projctl user get foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-user(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy_list.md: -------------------------------------------------------------------------------- 1 | ## projctl policy list 2 | 3 | Display all authorization policy resources 4 | 5 | ### Synopsis 6 | 7 | Display all authorization policy resources. 8 | 9 | ``` 10 | projctl policy list 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Display all policy resources 17 | projctl poicy list 18 | 19 | # Display all policy resources with offset and limit 20 | projctl policy list --offset=0 --limit=10 21 | ``` 22 | 23 | ### Options 24 | 25 | ``` 26 | -h, --help help for list 27 | -l, --limit int Specify the amount records to be returned. (default 1000) 28 | -o, --offset int Specify the offset of the first row to be returned. 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --alsologtostderr log to standard error as well as files 35 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 36 | --iamconfig string Path to the iamconfig file to use for CLI requests 37 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 38 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 39 | --log-dir string If non-empty, write log files in this directory 40 | --logtostderr log to standard error instead of files 41 | --match-server-version Require server version to match client version 42 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 43 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 44 | -s, --server.address string The address and port of the IAM API server 45 | --server.certificate-authority string Path to a cert file for the certificate authority 46 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 47 | --server.max-retries int Maximum number of retries. 48 | --server.retry-interval duration The interval time between each attempt. (default 1s) 49 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 50 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 51 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 52 | --user.client-certificate string Path to a client certificate file for TLS 53 | --user.client-key string Path to a client key file for TLS 54 | --user.password string Password for basic authentication to the API server 55 | --user.secret-id string SecretID for JWT authentication to the API server 56 | --user.secret-key string SecretKey for jwt authentication to the API server 57 | --user.token string Bearer token for authentication to the API server 58 | --user.username string Username for basic authentication to the API server 59 | -v, --v Level log level for V logs 60 | --version version[=true] Print version information and quit 61 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 62 | ``` 63 | 64 | ### SEE ALSO 65 | 66 | * [projctl policy](projctl_policy.md) - Manage authorization policies on iam platform 67 | 68 | ###### Auto generated by spf13/cobra on 29-Oct-2022 69 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-secret-delete.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl secret delete - Delete a secret resource 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl secret delete\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Delete a secret resource. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Delete secret foo 141 | projctl secret delete foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-secret(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-secret-get.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl secret get - Display a secret resource 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl secret get\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Display a secret resource. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Get a specified secret information 141 | projctl secret get foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-secret(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_user_create.md: -------------------------------------------------------------------------------- 1 | ## projctl user create 2 | 3 | Create a user resource 4 | 5 | ### Synopsis 6 | 7 | Create a user on iam platform. If nickname not specified, username will be used. 8 | 9 | ``` 10 | projctl user create USERNAME PASSWORD EMAIL 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Create user with given input 17 | projctl user create foo Foo@2020 foo@foxmail.com 18 | 19 | # Create user wt 20 | projctl user create foo Foo@2020 foo@foxmail.com --phone=18128845xxx --nickname=colin 21 | ``` 22 | 23 | ### Options 24 | 25 | ``` 26 | -h, --help help for create 27 | --nickname string The nickname of the user. 28 | --phone string The phone number of the user. 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --alsologtostderr log to standard error as well as files 35 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 36 | --iamconfig string Path to the iamconfig file to use for CLI requests 37 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 38 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 39 | --log-dir string If non-empty, write log files in this directory 40 | --logtostderr log to standard error instead of files 41 | --match-server-version Require server version to match client version 42 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 43 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 44 | -s, --server.address string The address and port of the IAM API server 45 | --server.certificate-authority string Path to a cert file for the certificate authority 46 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 47 | --server.max-retries int Maximum number of retries. 48 | --server.retry-interval duration The interval time between each attempt. (default 1s) 49 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 50 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 51 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 52 | --user.client-certificate string Path to a client certificate file for TLS 53 | --user.client-key string Path to a client key file for TLS 54 | --user.password string Password for basic authentication to the API server 55 | --user.secret-id string SecretID for JWT authentication to the API server 56 | --user.secret-key string SecretKey for jwt authentication to the API server 57 | --user.token string Bearer token for authentication to the API server 58 | --user.username string Username for basic authentication to the API server 59 | -v, --v Level log level for V logs 60 | --version version[=true] Print version information and quit 61 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 62 | ``` 63 | 64 | ### SEE ALSO 65 | 66 | * [projctl user](projctl_user.md) - Manage users on iam platform 67 | 68 | ###### Auto generated by spf13/cobra on 29-Oct-2022 69 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-policy-get.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl policy get - Display a authorization policy resource 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl policy get\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Display a authorization policy resource. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Display a policy resource 141 | projctl policy get foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-policy(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_user_update.md: -------------------------------------------------------------------------------- 1 | ## projctl user update 2 | 3 | Update a user resource 4 | 5 | ### Synopsis 6 | 7 | Update a user resource. 8 | 9 | Can only update nickname, email and phone. 10 | 11 | NOTICE: field will be updated to zero value if not specified. 12 | 13 | ``` 14 | projctl user update USERNAME 15 | ``` 16 | 17 | ### Examples 18 | 19 | ``` 20 | # Update use foo's information 21 | projctl user update foo --nickname=foo2 --email=foo@qq.com --phone=1812883xxxx 22 | ``` 23 | 24 | ### Options 25 | 26 | ``` 27 | --email string The email of the user. 28 | -h, --help help for update 29 | --nickname string The nickname of the user. 30 | --phone string The phone number of the user. 31 | ``` 32 | 33 | ### Options inherited from parent commands 34 | 35 | ``` 36 | --alsologtostderr log to standard error as well as files 37 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 38 | --iamconfig string Path to the iamconfig file to use for CLI requests 39 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 40 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 41 | --log-dir string If non-empty, write log files in this directory 42 | --logtostderr log to standard error instead of files 43 | --match-server-version Require server version to match client version 44 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 45 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 46 | -s, --server.address string The address and port of the IAM API server 47 | --server.certificate-authority string Path to a cert file for the certificate authority 48 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 49 | --server.max-retries int Maximum number of retries. 50 | --server.retry-interval duration The interval time between each attempt. (default 1s) 51 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 52 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 53 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 54 | --user.client-certificate string Path to a client certificate file for TLS 55 | --user.client-key string Path to a client key file for TLS 56 | --user.password string Password for basic authentication to the API server 57 | --user.secret-id string SecretID for JWT authentication to the API server 58 | --user.secret-key string SecretKey for jwt authentication to the API server 59 | --user.token string Bearer token for authentication to the API server 60 | --user.username string Username for basic authentication to the API server 61 | -v, --v Level log level for V logs 62 | --version version[=true] Print version information and quit 63 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 64 | ``` 65 | 66 | ### SEE ALSO 67 | 68 | * [projctl user](projctl_user.md) - Manage users on iam platform 69 | 70 | ###### Auto generated by spf13/cobra on 29-Oct-2022 71 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-options.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl options - Print the list of flags inherited by all commands 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl options\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Print the list of flags inherited by all commands 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Print flags inherited by all commands 141 | projctl options 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-policy-delete.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl policy delete - Delete a authorization policy resource 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl policy delete\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Delete a authorization policy resource. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Delete a policy resource 141 | projctl policy delete foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-policy(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret.md: -------------------------------------------------------------------------------- 1 | ## projctl secret 2 | 3 | Manage secrets on iam platform 4 | 5 | ### Synopsis 6 | 7 | Secret management commands. 8 | 9 | This commands allow you to manage your secret on iam platform. 10 | 11 | ``` 12 | projctl secret SUBCOMMAND 13 | ``` 14 | 15 | ### Options 16 | 17 | ``` 18 | -h, --help help for secret 19 | ``` 20 | 21 | ### Options inherited from parent commands 22 | 23 | ``` 24 | --alsologtostderr log to standard error as well as files 25 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 26 | --iamconfig string Path to the iamconfig file to use for CLI requests 27 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 28 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 29 | --log-dir string If non-empty, write log files in this directory 30 | --logtostderr log to standard error instead of files 31 | --match-server-version Require server version to match client version 32 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 33 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 34 | -s, --server.address string The address and port of the IAM API server 35 | --server.certificate-authority string Path to a cert file for the certificate authority 36 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 37 | --server.max-retries int Maximum number of retries. 38 | --server.retry-interval duration The interval time between each attempt. (default 1s) 39 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 40 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 41 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 42 | --user.client-certificate string Path to a client certificate file for TLS 43 | --user.client-key string Path to a client key file for TLS 44 | --user.password string Password for basic authentication to the API server 45 | --user.secret-id string SecretID for JWT authentication to the API server 46 | --user.secret-key string SecretKey for jwt authentication to the API server 47 | --user.token string Bearer token for authentication to the API server 48 | --user.username string Username for basic authentication to the API server 49 | -v, --v Level log level for V logs 50 | --version version[=true] Print version information and quit 51 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 52 | ``` 53 | 54 | ### SEE ALSO 55 | 56 | * [projctl](projctl.md) - projctl controls the superproj platform 57 | * [projctl secret create](projctl_secret_create.md) - Create secret resource 58 | * [projctl secret delete](projctl_secret_delete.md) - Delete a secret resource 59 | * [projctl secret get](projctl_secret_get.md) - Display a secret resource 60 | * [projctl secret list](projctl_secret_list.md) - Display all secret resources 61 | * [projctl secret update](projctl_secret_update.md) - Update a secret resource 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-validate.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl validate - Validate the basic environment for projctl to run 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl validate\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Validate the basic environment for projctl to run. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Validate the basic environment for projctl to run 141 | projctl validate 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy_create.md: -------------------------------------------------------------------------------- 1 | ## projctl policy create 2 | 3 | Create a authorization policy resource 4 | 5 | ### Synopsis 6 | 7 | Create a authorization policy resource. 8 | 9 | ``` 10 | projctl policy create POLICY_NAME POLICY 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Create a authorization policy 17 | projctl policy create foo '{"description":"This is a updated policy","subjects":["users:","users:maria","groups:admins"],"actions":["delete",""],"effect":"allow","resources":["resources:articles:<.*>","resources:printer"],"conditions":{"remoteIPAddress":{"type":"CIDRCondition","options":{"cidr":"192.168.0.1/16"}}}}' 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for create 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl policy](projctl_policy.md) - Manage authorization policies on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-secret.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl secret - Manage secrets on iam platform 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl secret\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Secret management commands. 19 | 20 | .PP 21 | This commands allow you to manage your secret on iam platform. 22 | 23 | 24 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 25 | .PP 26 | \fB--alsologtostderr\fP=false 27 | log to standard error as well as files 28 | 29 | .PP 30 | \fB-c\fP, \fB--config\fP="" 31 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | 33 | .PP 34 | \fB--iamconfig\fP="" 35 | Path to the iamconfig file to use for CLI requests 36 | 37 | .PP 38 | \fB--kubeconfig\fP="" 39 | Paths to a kubeconfig. Only required if out-of-cluster. 40 | 41 | .PP 42 | \fB--log-backtrace-at\fP=:0 43 | when logging hits line file:N, emit a stack trace 44 | 45 | .PP 46 | \fB--log-dir\fP="" 47 | If non-empty, write log files in this directory 48 | 49 | .PP 50 | \fB--logtostderr\fP=false 51 | log to standard error instead of files 52 | 53 | .PP 54 | \fB--match-server-version\fP=false 55 | Require server version to match client version 56 | 57 | .PP 58 | \fB--profile\fP="none" 59 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 60 | 61 | .PP 62 | \fB--profile-output\fP="profile.pprof" 63 | Name of the file to write the profile to 64 | 65 | .PP 66 | \fB-s\fP, \fB--server.address\fP="" 67 | The address and port of the IAM API server 68 | 69 | .PP 70 | \fB--server.certificate-authority\fP="" 71 | Path to a cert file for the certificate authority 72 | 73 | .PP 74 | \fB--server.insecure-skip-tls-verify\fP=false 75 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 | 77 | .PP 78 | \fB--server.max-retries\fP=0 79 | Maximum number of retries. 80 | 81 | .PP 82 | \fB--server.retry-interval\fP=1s 83 | The interval time between each attempt. 84 | 85 | .PP 86 | \fB--server.timeout\fP=30s 87 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 88 | 89 | .PP 90 | \fB--server.tls-server-name\fP="" 91 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 92 | 93 | .PP 94 | \fB--stderrthreshold\fP=2 95 | logs at or above this threshold go to stderr 96 | 97 | .PP 98 | \fB--user.client-certificate\fP="" 99 | Path to a client certificate file for TLS 100 | 101 | .PP 102 | \fB--user.client-key\fP="" 103 | Path to a client key file for TLS 104 | 105 | .PP 106 | \fB--user.password\fP="" 107 | Password for basic authentication to the API server 108 | 109 | .PP 110 | \fB--user.secret-id\fP="" 111 | SecretID for JWT authentication to the API server 112 | 113 | .PP 114 | \fB--user.secret-key\fP="" 115 | SecretKey for jwt authentication to the API server 116 | 117 | .PP 118 | \fB--user.token\fP="" 119 | Bearer token for authentication to the API server 120 | 121 | .PP 122 | \fB--user.username\fP="" 123 | Username for basic authentication to the API server 124 | 125 | .PP 126 | \fB-v\fP, \fB--v\fP=0 127 | log level for V logs 128 | 129 | .PP 130 | \fB--version\fP=false 131 | Print version information and quit 132 | 133 | .PP 134 | \fB--vmodule\fP= 135 | comma-separated list of pattern=N settings for file-filtered logging 136 | 137 | 138 | .SH SEE ALSO 139 | .PP 140 | \fBprojctl(1)\fP, \fBprojctl-secret-create(1)\fP, \fBprojctl-secret-delete(1)\fP, \fBprojctl-secret-get(1)\fP, \fBprojctl-secret-list(1)\fP, \fBprojctl-secret-update(1)\fP, 141 | 142 | 143 | .SH HISTORY 144 | .PP 145 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 146 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy_update.md: -------------------------------------------------------------------------------- 1 | ## projctl policy update 2 | 3 | Update a authorization policy resource 4 | 5 | ### Synopsis 6 | 7 | Update a authorization policy resource. 8 | 9 | ``` 10 | projctl policy update POLICY_NAME POLICY 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # Update a authorization policy with new policy. 17 | projctl policy update foo "{"description":"This is a updated policy","subjects":["users:","users:maria","groups:admins"],"actions":["delete",""],"effect":"allow","resources":["resources:articles:<.*>","resources:printer"],"conditions":{"remoteIPAddress":{"type":"CIDRCondition","options":{"cidr":"192.168.0.1/16"}}}}" 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help help for update 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --alsologtostderr log to standard error as well as files 30 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 31 | --iamconfig string Path to the iamconfig file to use for CLI requests 32 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 33 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 34 | --log-dir string If non-empty, write log files in this directory 35 | --logtostderr log to standard error instead of files 36 | --match-server-version Require server version to match client version 37 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 38 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 39 | -s, --server.address string The address and port of the IAM API server 40 | --server.certificate-authority string Path to a cert file for the certificate authority 41 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 42 | --server.max-retries int Maximum number of retries. 43 | --server.retry-interval duration The interval time between each attempt. (default 1s) 44 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 45 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 46 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 47 | --user.client-certificate string Path to a client certificate file for TLS 48 | --user.client-key string Path to a client key file for TLS 49 | --user.password string Password for basic authentication to the API server 50 | --user.secret-id string SecretID for JWT authentication to the API server 51 | --user.secret-key string SecretKey for jwt authentication to the API server 52 | --user.token string Bearer token for authentication to the API server 53 | --user.username string Username for basic authentication to the API server 54 | -v, --v Level log level for V logs 55 | --version version[=true] Print version information and quit 56 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 57 | ``` 58 | 59 | ### SEE ALSO 60 | 61 | * [projctl policy](projctl_policy.md) - Manage authorization policies on iam platform 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/.generated_docs: -------------------------------------------------------------------------------- 1 | docs/.generated_docs 2 | docs/guide/en-US/cmd/projctl/projctl.md 3 | docs/guide/en-US/cmd/projctl/projctl_color.md 4 | docs/guide/en-US/cmd/projctl/projctl_completion.md 5 | docs/guide/en-US/cmd/projctl/projctl_info.md 6 | docs/guide/en-US/cmd/projctl/projctl_jwt.md 7 | docs/guide/en-US/cmd/projctl/projctl_jwt_show.md 8 | docs/guide/en-US/cmd/projctl/projctl_jwt_sign.md 9 | docs/guide/en-US/cmd/projctl/projctl_jwt_verify.md 10 | docs/guide/en-US/cmd/projctl/projctl_new.md 11 | docs/guide/en-US/cmd/projctl/projctl_options.md 12 | docs/guide/en-US/cmd/projctl/projctl_policy.md 13 | docs/guide/en-US/cmd/projctl/projctl_policy_create.md 14 | docs/guide/en-US/cmd/projctl/projctl_policy_delete.md 15 | docs/guide/en-US/cmd/projctl/projctl_policy_get.md 16 | docs/guide/en-US/cmd/projctl/projctl_policy_list.md 17 | docs/guide/en-US/cmd/projctl/projctl_policy_update.md 18 | docs/guide/en-US/cmd/projctl/projctl_secret.md 19 | docs/guide/en-US/cmd/projctl/projctl_secret_create.md 20 | docs/guide/en-US/cmd/projctl/projctl_secret_delete.md 21 | docs/guide/en-US/cmd/projctl/projctl_secret_get.md 22 | docs/guide/en-US/cmd/projctl/projctl_secret_list.md 23 | docs/guide/en-US/cmd/projctl/projctl_secret_update.md 24 | docs/guide/en-US/cmd/projctl/projctl_set.md 25 | docs/guide/en-US/cmd/projctl/projctl_user.md 26 | docs/guide/en-US/cmd/projctl/projctl_user_create.md 27 | docs/guide/en-US/cmd/projctl/projctl_user_delete.md 28 | docs/guide/en-US/cmd/projctl/projctl_user_get.md 29 | docs/guide/en-US/cmd/projctl/projctl_user_list.md 30 | docs/guide/en-US/cmd/projctl/projctl_user_update.md 31 | docs/guide/en-US/cmd/projctl/projctl_validate.md 32 | docs/guide/en-US/cmd/projctl/projctl_version.md 33 | docs/guide/en-US/cmd/superproj-apiserver.md 34 | docs/guide/en-US/cmd/superproj-controller-manager.md 35 | docs/guide/en-US/cmd/superproj-gw.md 36 | docs/guide/en-US/cmd/superproj-miner-controller.md 37 | docs/guide/en-US/cmd/superproj-minerset-controller.md 38 | docs/guide/en-US/cmd/superproj-nightwatch.md 39 | docs/guide/en-US/cmd/superproj-pump.md 40 | docs/guide/en-US/yaml/projctl/projctl.yaml 41 | docs/guide/en-US/yaml/projctl/projctl_color.yaml 42 | docs/guide/en-US/yaml/projctl/projctl_completion.yaml 43 | docs/guide/en-US/yaml/projctl/projctl_info.yaml 44 | docs/guide/en-US/yaml/projctl/projctl_jwt.yaml 45 | docs/guide/en-US/yaml/projctl/projctl_new.yaml 46 | docs/guide/en-US/yaml/projctl/projctl_options.yaml 47 | docs/guide/en-US/yaml/projctl/projctl_policy.yaml 48 | docs/guide/en-US/yaml/projctl/projctl_secret.yaml 49 | docs/guide/en-US/yaml/projctl/projctl_set.yaml 50 | docs/guide/en-US/yaml/projctl/projctl_user.yaml 51 | docs/guide/en-US/yaml/projctl/projctl_validate.yaml 52 | docs/guide/en-US/yaml/projctl/projctl_version.yaml 53 | docs/man/man1/projctl-color.1 54 | docs/man/man1/projctl-completion.1 55 | docs/man/man1/projctl-info.1 56 | docs/man/man1/projctl-jwt-show.1 57 | docs/man/man1/projctl-jwt-sign.1 58 | docs/man/man1/projctl-jwt-verify.1 59 | docs/man/man1/projctl-jwt.1 60 | docs/man/man1/projctl-new.1 61 | docs/man/man1/projctl-options.1 62 | docs/man/man1/projctl-policy-create.1 63 | docs/man/man1/projctl-policy-delete.1 64 | docs/man/man1/projctl-policy-get.1 65 | docs/man/man1/projctl-policy-list.1 66 | docs/man/man1/projctl-policy-update.1 67 | docs/man/man1/projctl-policy.1 68 | docs/man/man1/projctl-secret-create.1 69 | docs/man/man1/projctl-secret-delete.1 70 | docs/man/man1/projctl-secret-get.1 71 | docs/man/man1/projctl-secret-list.1 72 | docs/man/man1/projctl-secret-update.1 73 | docs/man/man1/projctl-secret.1 74 | docs/man/man1/projctl-set.1 75 | docs/man/man1/projctl-user-create.1 76 | docs/man/man1/projctl-user-delete.1 77 | docs/man/man1/projctl-user-get.1 78 | docs/man/man1/projctl-user-list.1 79 | docs/man/man1/projctl-user-update.1 80 | docs/man/man1/projctl-user.1 81 | docs/man/man1/projctl-validate.1 82 | docs/man/man1/projctl-version.1 83 | docs/man/man1/projctl.1 84 | docs/man/man1/superproj-apiserver.1 85 | docs/man/man1/superproj-controller-manager.1 86 | docs/man/man1/superproj-gw.1 87 | docs/man/man1/superproj-miner-controller.1 88 | docs/man/man1/superproj-minerset-controller.1 89 | docs/man/man1/superproj-nightwatch.1 90 | docs/man/man1/superproj-pump.1 91 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-policy.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl policy - Manage authorization policies on iam platform 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl policy\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Authorization policy management commands. 19 | 20 | .PP 21 | This commands allow you to manage your authorization policy on iam platform. 22 | 23 | 24 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 25 | .PP 26 | \fB--alsologtostderr\fP=false 27 | log to standard error as well as files 28 | 29 | .PP 30 | \fB-c\fP, \fB--config\fP="" 31 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | 33 | .PP 34 | \fB--iamconfig\fP="" 35 | Path to the iamconfig file to use for CLI requests 36 | 37 | .PP 38 | \fB--kubeconfig\fP="" 39 | Paths to a kubeconfig. Only required if out-of-cluster. 40 | 41 | .PP 42 | \fB--log-backtrace-at\fP=:0 43 | when logging hits line file:N, emit a stack trace 44 | 45 | .PP 46 | \fB--log-dir\fP="" 47 | If non-empty, write log files in this directory 48 | 49 | .PP 50 | \fB--logtostderr\fP=false 51 | log to standard error instead of files 52 | 53 | .PP 54 | \fB--match-server-version\fP=false 55 | Require server version to match client version 56 | 57 | .PP 58 | \fB--profile\fP="none" 59 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 60 | 61 | .PP 62 | \fB--profile-output\fP="profile.pprof" 63 | Name of the file to write the profile to 64 | 65 | .PP 66 | \fB-s\fP, \fB--server.address\fP="" 67 | The address and port of the IAM API server 68 | 69 | .PP 70 | \fB--server.certificate-authority\fP="" 71 | Path to a cert file for the certificate authority 72 | 73 | .PP 74 | \fB--server.insecure-skip-tls-verify\fP=false 75 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 | 77 | .PP 78 | \fB--server.max-retries\fP=0 79 | Maximum number of retries. 80 | 81 | .PP 82 | \fB--server.retry-interval\fP=1s 83 | The interval time between each attempt. 84 | 85 | .PP 86 | \fB--server.timeout\fP=30s 87 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 88 | 89 | .PP 90 | \fB--server.tls-server-name\fP="" 91 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 92 | 93 | .PP 94 | \fB--stderrthreshold\fP=2 95 | logs at or above this threshold go to stderr 96 | 97 | .PP 98 | \fB--user.client-certificate\fP="" 99 | Path to a client certificate file for TLS 100 | 101 | .PP 102 | \fB--user.client-key\fP="" 103 | Path to a client key file for TLS 104 | 105 | .PP 106 | \fB--user.password\fP="" 107 | Password for basic authentication to the API server 108 | 109 | .PP 110 | \fB--user.secret-id\fP="" 111 | SecretID for JWT authentication to the API server 112 | 113 | .PP 114 | \fB--user.secret-key\fP="" 115 | SecretKey for jwt authentication to the API server 116 | 117 | .PP 118 | \fB--user.token\fP="" 119 | Bearer token for authentication to the API server 120 | 121 | .PP 122 | \fB--user.username\fP="" 123 | Username for basic authentication to the API server 124 | 125 | .PP 126 | \fB-v\fP, \fB--v\fP=0 127 | log level for V logs 128 | 129 | .PP 130 | \fB--version\fP=false 131 | Print version information and quit 132 | 133 | .PP 134 | \fB--vmodule\fP= 135 | comma-separated list of pattern=N settings for file-filtered logging 136 | 137 | 138 | .SH SEE ALSO 139 | .PP 140 | \fBprojctl(1)\fP, \fBprojctl-policy-create(1)\fP, \fBprojctl-policy-delete(1)\fP, \fBprojctl-policy-get(1)\fP, \fBprojctl-policy-list(1)\fP, \fBprojctl-policy-update(1)\fP, 141 | 142 | 143 | .SH HISTORY 144 | .PP 145 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 146 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-user-delete.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl user delete - Delete a user resource from iam platform (Administrator rights required) 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl user delete\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Delete a user resource from iam platform, only administrator can do this operation. 19 | 20 | 21 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 22 | .PP 23 | \fB--alsologtostderr\fP=false 24 | log to standard error as well as files 25 | 26 | .PP 27 | \fB-c\fP, \fB--config\fP="" 28 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 29 | 30 | .PP 31 | \fB--iamconfig\fP="" 32 | Path to the iamconfig file to use for CLI requests 33 | 34 | .PP 35 | \fB--kubeconfig\fP="" 36 | Paths to a kubeconfig. Only required if out-of-cluster. 37 | 38 | .PP 39 | \fB--log-backtrace-at\fP=:0 40 | when logging hits line file:N, emit a stack trace 41 | 42 | .PP 43 | \fB--log-dir\fP="" 44 | If non-empty, write log files in this directory 45 | 46 | .PP 47 | \fB--logtostderr\fP=false 48 | log to standard error instead of files 49 | 50 | .PP 51 | \fB--match-server-version\fP=false 52 | Require server version to match client version 53 | 54 | .PP 55 | \fB--profile\fP="none" 56 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 57 | 58 | .PP 59 | \fB--profile-output\fP="profile.pprof" 60 | Name of the file to write the profile to 61 | 62 | .PP 63 | \fB-s\fP, \fB--server.address\fP="" 64 | The address and port of the IAM API server 65 | 66 | .PP 67 | \fB--server.certificate-authority\fP="" 68 | Path to a cert file for the certificate authority 69 | 70 | .PP 71 | \fB--server.insecure-skip-tls-verify\fP=false 72 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 73 | 74 | .PP 75 | \fB--server.max-retries\fP=0 76 | Maximum number of retries. 77 | 78 | .PP 79 | \fB--server.retry-interval\fP=1s 80 | The interval time between each attempt. 81 | 82 | .PP 83 | \fB--server.timeout\fP=30s 84 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 85 | 86 | .PP 87 | \fB--server.tls-server-name\fP="" 88 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 89 | 90 | .PP 91 | \fB--stderrthreshold\fP=2 92 | logs at or above this threshold go to stderr 93 | 94 | .PP 95 | \fB--user.client-certificate\fP="" 96 | Path to a client certificate file for TLS 97 | 98 | .PP 99 | \fB--user.client-key\fP="" 100 | Path to a client key file for TLS 101 | 102 | .PP 103 | \fB--user.password\fP="" 104 | Password for basic authentication to the API server 105 | 106 | .PP 107 | \fB--user.secret-id\fP="" 108 | SecretID for JWT authentication to the API server 109 | 110 | .PP 111 | \fB--user.secret-key\fP="" 112 | SecretKey for jwt authentication to the API server 113 | 114 | .PP 115 | \fB--user.token\fP="" 116 | Bearer token for authentication to the API server 117 | 118 | .PP 119 | \fB--user.username\fP="" 120 | Username for basic authentication to the API server 121 | 122 | .PP 123 | \fB-v\fP, \fB--v\fP=0 124 | log level for V logs 125 | 126 | .PP 127 | \fB--version\fP=false 128 | Print version information and quit 129 | 130 | .PP 131 | \fB--vmodule\fP= 132 | comma-separated list of pattern=N settings for file-filtered logging 133 | 134 | 135 | .SH EXAMPLE 136 | .PP 137 | .RS 138 | 139 | .nf 140 | # Delete user foo from platform 141 | projctl user delete foo 142 | 143 | .fi 144 | .RE 145 | 146 | 147 | .SH SEE ALSO 148 | .PP 149 | \fBprojctl-user(1)\fP, 150 | 151 | 152 | .SH HISTORY 153 | .PP 154 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 155 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_secret_create.md: -------------------------------------------------------------------------------- 1 | ## projctl secret create 2 | 3 | Create secret resource 4 | 5 | ### Synopsis 6 | 7 | Create secret resource. 8 | 9 | This will generate secretID and secretKey which can be used to sign JWT token. 10 | 11 | ``` 12 | projctl secret create SECRET_NAME 13 | ``` 14 | 15 | ### Examples 16 | 17 | ``` 18 | # Create secret which will expired after 2 hours 19 | projctl secret create foo 20 | 21 | # Create secret with a specified expire time and description 22 | projctl secret create foo --expires=1988121600 --description="secret for iam" 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | --description string The descriptin of the secret. 29 | --expires int The expire time of the secret. (default 1667534344) 30 | -h, --help help for create 31 | ``` 32 | 33 | ### Options inherited from parent commands 34 | 35 | ``` 36 | --alsologtostderr log to standard error as well as files 37 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 38 | --iamconfig string Path to the iamconfig file to use for CLI requests 39 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 40 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 41 | --log-dir string If non-empty, write log files in this directory 42 | --logtostderr log to standard error instead of files 43 | --match-server-version Require server version to match client version 44 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 45 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 46 | -s, --server.address string The address and port of the IAM API server 47 | --server.certificate-authority string Path to a cert file for the certificate authority 48 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 49 | --server.max-retries int Maximum number of retries. 50 | --server.retry-interval duration The interval time between each attempt. (default 1s) 51 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 52 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 53 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 54 | --user.client-certificate string Path to a client certificate file for TLS 55 | --user.client-key string Path to a client key file for TLS 56 | --user.password string Password for basic authentication to the API server 57 | --user.secret-id string SecretID for JWT authentication to the API server 58 | --user.secret-key string SecretKey for jwt authentication to the API server 59 | --user.token string Bearer token for authentication to the API server 60 | --user.username string Username for basic authentication to the API server 61 | -v, --v Level log level for V logs 62 | --version version[=true] Print version information and quit 63 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 64 | ``` 65 | 66 | ### SEE ALSO 67 | 68 | * [projctl secret](projctl_secret.md) - Manage secrets on iam platform 69 | 70 | ###### Auto generated by spf13/cobra on 29-Oct-2022 71 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-jwt-show.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl jwt show - Show header and claims for a JWT token 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl jwt show\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Show header and claims for a JWT token 19 | 20 | 21 | .SH OPTIONS 22 | .PP 23 | \fB--compact\fP=false 24 | output compact JSON. 25 | 26 | 27 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 28 | .PP 29 | \fB--alsologtostderr\fP=false 30 | log to standard error as well as files 31 | 32 | .PP 33 | \fB-c\fP, \fB--config\fP="" 34 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 35 | 36 | .PP 37 | \fB--iamconfig\fP="" 38 | Path to the iamconfig file to use for CLI requests 39 | 40 | .PP 41 | \fB--kubeconfig\fP="" 42 | Paths to a kubeconfig. Only required if out-of-cluster. 43 | 44 | .PP 45 | \fB--log-backtrace-at\fP=:0 46 | when logging hits line file:N, emit a stack trace 47 | 48 | .PP 49 | \fB--log-dir\fP="" 50 | If non-empty, write log files in this directory 51 | 52 | .PP 53 | \fB--logtostderr\fP=false 54 | log to standard error instead of files 55 | 56 | .PP 57 | \fB--match-server-version\fP=false 58 | Require server version to match client version 59 | 60 | .PP 61 | \fB--profile\fP="none" 62 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 63 | 64 | .PP 65 | \fB--profile-output\fP="profile.pprof" 66 | Name of the file to write the profile to 67 | 68 | .PP 69 | \fB-s\fP, \fB--server.address\fP="" 70 | The address and port of the IAM API server 71 | 72 | .PP 73 | \fB--server.certificate-authority\fP="" 74 | Path to a cert file for the certificate authority 75 | 76 | .PP 77 | \fB--server.insecure-skip-tls-verify\fP=false 78 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 79 | 80 | .PP 81 | \fB--server.max-retries\fP=0 82 | Maximum number of retries. 83 | 84 | .PP 85 | \fB--server.retry-interval\fP=1s 86 | The interval time between each attempt. 87 | 88 | .PP 89 | \fB--server.timeout\fP=30s 90 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 91 | 92 | .PP 93 | \fB--server.tls-server-name\fP="" 94 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 95 | 96 | .PP 97 | \fB--stderrthreshold\fP=2 98 | logs at or above this threshold go to stderr 99 | 100 | .PP 101 | \fB--user.client-certificate\fP="" 102 | Path to a client certificate file for TLS 103 | 104 | .PP 105 | \fB--user.client-key\fP="" 106 | Path to a client key file for TLS 107 | 108 | .PP 109 | \fB--user.password\fP="" 110 | Password for basic authentication to the API server 111 | 112 | .PP 113 | \fB--user.secret-id\fP="" 114 | SecretID for JWT authentication to the API server 115 | 116 | .PP 117 | \fB--user.secret-key\fP="" 118 | SecretKey for jwt authentication to the API server 119 | 120 | .PP 121 | \fB--user.token\fP="" 122 | Bearer token for authentication to the API server 123 | 124 | .PP 125 | \fB--user.username\fP="" 126 | Username for basic authentication to the API server 127 | 128 | .PP 129 | \fB-v\fP, \fB--v\fP=0 130 | log level for V logs 131 | 132 | .PP 133 | \fB--version\fP=false 134 | Print version information and quit 135 | 136 | .PP 137 | \fB--vmodule\fP= 138 | comma-separated list of pattern=N settings for file-filtered logging 139 | 140 | 141 | .SH EXAMPLE 142 | .PP 143 | .RS 144 | 145 | .nf 146 | # Show header and Claims for a JWT token 147 | projctl jwt show XXX.XXX.XXX 148 | 149 | .fi 150 | .RE 151 | 152 | 153 | .SH SEE ALSO 154 | .PP 155 | \fBprojctl-jwt(1)\fP, 156 | 157 | 158 | .SH HISTORY 159 | .PP 160 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 161 | -------------------------------------------------------------------------------- /docs/guide/en-US/cmd/projctl/projctl_policy.md: -------------------------------------------------------------------------------- 1 | ## projctl policy 2 | 3 | Manage authorization policies on iam platform 4 | 5 | ### Synopsis 6 | 7 | Authorization policy management commands. 8 | 9 | This commands allow you to manage your authorization policy on iam platform. 10 | 11 | ``` 12 | projctl policy SUBCOMMAND 13 | ``` 14 | 15 | ### Options 16 | 17 | ``` 18 | -h, --help help for policy 19 | ``` 20 | 21 | ### Options inherited from parent commands 22 | 23 | ``` 24 | --alsologtostderr log to standard error as well as files 25 | -c, --config FILE Read configuration from specified FILE, support JSON, TOML, YAML, HCL, or Java properties formats. 26 | --iamconfig string Path to the iamconfig file to use for CLI requests 27 | --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. 28 | --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) 29 | --log-dir string If non-empty, write log files in this directory 30 | --logtostderr log to standard error instead of files 31 | --match-server-version Require server version to match client version 32 | --profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none") 33 | --profile-output string Name of the file to write the profile to (default "profile.pprof") 34 | -s, --server.address string The address and port of the IAM API server 35 | --server.certificate-authority string Path to a cert file for the certificate authority 36 | --server.insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 37 | --server.max-retries int Maximum number of retries. 38 | --server.retry-interval duration The interval time between each attempt. (default 1s) 39 | --server.timeout duration The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default 30s) 40 | --server.tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 41 | --stderrthreshold severity logs at or above this threshold go to stderr (default 2) 42 | --user.client-certificate string Path to a client certificate file for TLS 43 | --user.client-key string Path to a client key file for TLS 44 | --user.password string Password for basic authentication to the API server 45 | --user.secret-id string SecretID for JWT authentication to the API server 46 | --user.secret-key string SecretKey for jwt authentication to the API server 47 | --user.token string Bearer token for authentication to the API server 48 | --user.username string Username for basic authentication to the API server 49 | -v, --v Level log level for V logs 50 | --version version[=true] Print version information and quit 51 | --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 52 | ``` 53 | 54 | ### SEE ALSO 55 | 56 | * [projctl](projctl.md) - projctl controls the superproj platform 57 | * [projctl policy create](projctl_policy_create.md) - Create a authorization policy resource 58 | * [projctl policy delete](projctl_policy_delete.md) - Delete a authorization policy resource 59 | * [projctl policy get](projctl_policy_get.md) - Display a authorization policy resource 60 | * [projctl policy list](projctl_policy_list.md) - Display all authorization policy resources 61 | * [projctl policy update](projctl_policy_update.md) - Update a authorization policy resource 62 | 63 | ###### Auto generated by spf13/cobra on 29-Oct-2022 64 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-jwt-verify.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl jwt verify - Verify a JWT token 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl jwt verify\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Verify a JWT token 19 | 20 | 21 | .SH OPTIONS 22 | .PP 23 | \fB--compact\fP=false 24 | Output compact JSON. 25 | 26 | .PP 27 | \fB--debug\fP=false 28 | Print out all kinds of debug data. 29 | 30 | 31 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 32 | .PP 33 | \fB--alsologtostderr\fP=false 34 | log to standard error as well as files 35 | 36 | .PP 37 | \fB-c\fP, \fB--config\fP="" 38 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 39 | 40 | .PP 41 | \fB--iamconfig\fP="" 42 | Path to the iamconfig file to use for CLI requests 43 | 44 | .PP 45 | \fB--kubeconfig\fP="" 46 | Paths to a kubeconfig. Only required if out-of-cluster. 47 | 48 | .PP 49 | \fB--log-backtrace-at\fP=:0 50 | when logging hits line file:N, emit a stack trace 51 | 52 | .PP 53 | \fB--log-dir\fP="" 54 | If non-empty, write log files in this directory 55 | 56 | .PP 57 | \fB--logtostderr\fP=false 58 | log to standard error instead of files 59 | 60 | .PP 61 | \fB--match-server-version\fP=false 62 | Require server version to match client version 63 | 64 | .PP 65 | \fB--profile\fP="none" 66 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 67 | 68 | .PP 69 | \fB--profile-output\fP="profile.pprof" 70 | Name of the file to write the profile to 71 | 72 | .PP 73 | \fB-s\fP, \fB--server.address\fP="" 74 | The address and port of the IAM API server 75 | 76 | .PP 77 | \fB--server.certificate-authority\fP="" 78 | Path to a cert file for the certificate authority 79 | 80 | .PP 81 | \fB--server.insecure-skip-tls-verify\fP=false 82 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 83 | 84 | .PP 85 | \fB--server.max-retries\fP=0 86 | Maximum number of retries. 87 | 88 | .PP 89 | \fB--server.retry-interval\fP=1s 90 | The interval time between each attempt. 91 | 92 | .PP 93 | \fB--server.timeout\fP=30s 94 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 95 | 96 | .PP 97 | \fB--server.tls-server-name\fP="" 98 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 99 | 100 | .PP 101 | \fB--stderrthreshold\fP=2 102 | logs at or above this threshold go to stderr 103 | 104 | .PP 105 | \fB--user.client-certificate\fP="" 106 | Path to a client certificate file for TLS 107 | 108 | .PP 109 | \fB--user.client-key\fP="" 110 | Path to a client key file for TLS 111 | 112 | .PP 113 | \fB--user.password\fP="" 114 | Password for basic authentication to the API server 115 | 116 | .PP 117 | \fB--user.secret-id\fP="" 118 | SecretID for JWT authentication to the API server 119 | 120 | .PP 121 | \fB--user.secret-key\fP="" 122 | SecretKey for jwt authentication to the API server 123 | 124 | .PP 125 | \fB--user.token\fP="" 126 | Bearer token for authentication to the API server 127 | 128 | .PP 129 | \fB--user.username\fP="" 130 | Username for basic authentication to the API server 131 | 132 | .PP 133 | \fB-v\fP, \fB--v\fP=0 134 | log level for V logs 135 | 136 | .PP 137 | \fB--version\fP=false 138 | Print version information and quit 139 | 140 | .PP 141 | \fB--vmodule\fP= 142 | comma-separated list of pattern=N settings for file-filtered logging 143 | 144 | 145 | .SH EXAMPLE 146 | .PP 147 | .RS 148 | 149 | .nf 150 | # Verify a JWT token 151 | projctl jwt verify XXX xxxxx.yyyyy.zzzzz 152 | 153 | .fi 154 | .RE 155 | 156 | 157 | .SH SEE ALSO 158 | .PP 159 | \fBprojctl-jwt(1)\fP, 160 | 161 | 162 | .SH HISTORY 163 | .PP 164 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 165 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-user.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl user - Manage users on iam platform 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl user\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | User management commands. 19 | 20 | .PP 21 | Administrator can use all subcommands, non-administrator only allow to use create/get/upate. When call get/update non-administrator only allow to operate their own resources, if permission not allowed, will return an 'Permission denied' error. 22 | 23 | 24 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 25 | .PP 26 | \fB--alsologtostderr\fP=false 27 | log to standard error as well as files 28 | 29 | .PP 30 | \fB-c\fP, \fB--config\fP="" 31 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 32 | 33 | .PP 34 | \fB--iamconfig\fP="" 35 | Path to the iamconfig file to use for CLI requests 36 | 37 | .PP 38 | \fB--kubeconfig\fP="" 39 | Paths to a kubeconfig. Only required if out-of-cluster. 40 | 41 | .PP 42 | \fB--log-backtrace-at\fP=:0 43 | when logging hits line file:N, emit a stack trace 44 | 45 | .PP 46 | \fB--log-dir\fP="" 47 | If non-empty, write log files in this directory 48 | 49 | .PP 50 | \fB--logtostderr\fP=false 51 | log to standard error instead of files 52 | 53 | .PP 54 | \fB--match-server-version\fP=false 55 | Require server version to match client version 56 | 57 | .PP 58 | \fB--profile\fP="none" 59 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 60 | 61 | .PP 62 | \fB--profile-output\fP="profile.pprof" 63 | Name of the file to write the profile to 64 | 65 | .PP 66 | \fB-s\fP, \fB--server.address\fP="" 67 | The address and port of the IAM API server 68 | 69 | .PP 70 | \fB--server.certificate-authority\fP="" 71 | Path to a cert file for the certificate authority 72 | 73 | .PP 74 | \fB--server.insecure-skip-tls-verify\fP=false 75 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 | 77 | .PP 78 | \fB--server.max-retries\fP=0 79 | Maximum number of retries. 80 | 81 | .PP 82 | \fB--server.retry-interval\fP=1s 83 | The interval time between each attempt. 84 | 85 | .PP 86 | \fB--server.timeout\fP=30s 87 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 88 | 89 | .PP 90 | \fB--server.tls-server-name\fP="" 91 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 92 | 93 | .PP 94 | \fB--stderrthreshold\fP=2 95 | logs at or above this threshold go to stderr 96 | 97 | .PP 98 | \fB--user.client-certificate\fP="" 99 | Path to a client certificate file for TLS 100 | 101 | .PP 102 | \fB--user.client-key\fP="" 103 | Path to a client key file for TLS 104 | 105 | .PP 106 | \fB--user.password\fP="" 107 | Password for basic authentication to the API server 108 | 109 | .PP 110 | \fB--user.secret-id\fP="" 111 | SecretID for JWT authentication to the API server 112 | 113 | .PP 114 | \fB--user.secret-key\fP="" 115 | SecretKey for jwt authentication to the API server 116 | 117 | .PP 118 | \fB--user.token\fP="" 119 | Bearer token for authentication to the API server 120 | 121 | .PP 122 | \fB--user.username\fP="" 123 | Username for basic authentication to the API server 124 | 125 | .PP 126 | \fB-v\fP, \fB--v\fP=0 127 | log level for V logs 128 | 129 | .PP 130 | \fB--version\fP=false 131 | Print version information and quit 132 | 133 | .PP 134 | \fB--vmodule\fP= 135 | comma-separated list of pattern=N settings for file-filtered logging 136 | 137 | 138 | .SH SEE ALSO 139 | .PP 140 | \fBprojctl(1)\fP, \fBprojctl-user-create(1)\fP, \fBprojctl-user-delete(1)\fP, \fBprojctl-user-get(1)\fP, \fBprojctl-user-list(1)\fP, \fBprojctl-user-update(1)\fP, 141 | 142 | 143 | .SH HISTORY 144 | .PP 145 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 146 | -------------------------------------------------------------------------------- /docs/man/man1/projctl-secret-update.1: -------------------------------------------------------------------------------- 1 | .nh 2 | .TH SuperProj(1) superproj User Manuals 3 | Eric Paris 4 | Jan 2015 5 | 6 | .SH NAME 7 | .PP 8 | projctl secret update - Update a secret resource 9 | 10 | 11 | .SH SYNOPSIS 12 | .PP 13 | \fBprojctl secret update\fP [OPTIONS] 14 | 15 | 16 | .SH DESCRIPTION 17 | .PP 18 | Update a secret resource. 19 | 20 | 21 | .SH OPTIONS 22 | .PP 23 | \fB--description\fP="" 24 | The description of the secret. 25 | 26 | .PP 27 | \fB--expires\fP=0 28 | The expires of the secret. 29 | 30 | 31 | .SH OPTIONS INHERITED FROM PARENT COMMANDS 32 | .PP 33 | \fB--alsologtostderr\fP=false 34 | log to standard error as well as files 35 | 36 | .PP 37 | \fB-c\fP, \fB--config\fP="" 38 | Read configuration from specified \fB\fCFILE\fR, support JSON, TOML, YAML, HCL, or Java properties formats. 39 | 40 | .PP 41 | \fB--iamconfig\fP="" 42 | Path to the iamconfig file to use for CLI requests 43 | 44 | .PP 45 | \fB--kubeconfig\fP="" 46 | Paths to a kubeconfig. Only required if out-of-cluster. 47 | 48 | .PP 49 | \fB--log-backtrace-at\fP=:0 50 | when logging hits line file:N, emit a stack trace 51 | 52 | .PP 53 | \fB--log-dir\fP="" 54 | If non-empty, write log files in this directory 55 | 56 | .PP 57 | \fB--logtostderr\fP=false 58 | log to standard error instead of files 59 | 60 | .PP 61 | \fB--match-server-version\fP=false 62 | Require server version to match client version 63 | 64 | .PP 65 | \fB--profile\fP="none" 66 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 67 | 68 | .PP 69 | \fB--profile-output\fP="profile.pprof" 70 | Name of the file to write the profile to 71 | 72 | .PP 73 | \fB-s\fP, \fB--server.address\fP="" 74 | The address and port of the IAM API server 75 | 76 | .PP 77 | \fB--server.certificate-authority\fP="" 78 | Path to a cert file for the certificate authority 79 | 80 | .PP 81 | \fB--server.insecure-skip-tls-verify\fP=false 82 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 83 | 84 | .PP 85 | \fB--server.max-retries\fP=0 86 | Maximum number of retries. 87 | 88 | .PP 89 | \fB--server.retry-interval\fP=1s 90 | The interval time between each attempt. 91 | 92 | .PP 93 | \fB--server.timeout\fP=30s 94 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 95 | 96 | .PP 97 | \fB--server.tls-server-name\fP="" 98 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 99 | 100 | .PP 101 | \fB--stderrthreshold\fP=2 102 | logs at or above this threshold go to stderr 103 | 104 | .PP 105 | \fB--user.client-certificate\fP="" 106 | Path to a client certificate file for TLS 107 | 108 | .PP 109 | \fB--user.client-key\fP="" 110 | Path to a client key file for TLS 111 | 112 | .PP 113 | \fB--user.password\fP="" 114 | Password for basic authentication to the API server 115 | 116 | .PP 117 | \fB--user.secret-id\fP="" 118 | SecretID for JWT authentication to the API server 119 | 120 | .PP 121 | \fB--user.secret-key\fP="" 122 | SecretKey for jwt authentication to the API server 123 | 124 | .PP 125 | \fB--user.token\fP="" 126 | Bearer token for authentication to the API server 127 | 128 | .PP 129 | \fB--user.username\fP="" 130 | Username for basic authentication to the API server 131 | 132 | .PP 133 | \fB-v\fP, \fB--v\fP=0 134 | log level for V logs 135 | 136 | .PP 137 | \fB--version\fP=false 138 | Print version information and quit 139 | 140 | .PP 141 | \fB--vmodule\fP= 142 | comma-separated list of pattern=N settings for file-filtered logging 143 | 144 | 145 | .SH EXAMPLE 146 | .PP 147 | .RS 148 | 149 | .nf 150 | # Update a secret resource 151 | projctl secret update foo --expires=4h --description="new description" 152 | 153 | .fi 154 | .RE 155 | 156 | 157 | .SH SEE ALSO 158 | .PP 159 | \fBprojctl-secret(1)\fP, 160 | 161 | 162 | .SH HISTORY 163 | .PP 164 | January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the marmotedu source material, but hopefully they have been automatically generated since! 165 | -------------------------------------------------------------------------------- /docs/guide/en-US/yaml/projctl/projctl_completion.yaml: -------------------------------------------------------------------------------- 1 | name: completion 2 | synopsis: | 3 | Output shell completion code for the specified shell (bash or zsh) 4 | description: |- 5 | Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of projctl commands. This can be done by sourcing it from the .bash_profile. 6 | 7 | Detailed instructions on how to do this are available here: http://github.com/superproj/superproj/docs/installation/projctl.md#enabling-shell-autocompletion 8 | 9 | Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 10 | inheritedOptions: 11 | - name: iamconfig 12 | usage: Path to the iamconfig file to use for CLI requests 13 | - name: match-server-version 14 | defaultValue: "false" 15 | usage: Require server version to match client version 16 | - name: profile 17 | defaultValue: none 18 | usage: | 19 | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) 20 | - name: profile-output 21 | defaultValue: profile.pprof 22 | usage: Name of the file to write the profile to 23 | - name: server.address 24 | shorthand: s 25 | usage: The address and port of the IAM API server 26 | - name: server.certificate-authority 27 | usage: Path to a cert file for the certificate authority 28 | - name: server.insecure-skip-tls-verify 29 | defaultValue: "false" 30 | usage: | 31 | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 32 | - name: server.max-retries 33 | defaultValue: "0" 34 | usage: Maximum number of retries. 35 | - name: server.retry-interval 36 | defaultValue: 1s 37 | usage: The interval time between each attempt. 38 | - name: server.timeout 39 | defaultValue: 30s 40 | usage: | 41 | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. 42 | - name: server.tls-server-name 43 | usage: | 44 | Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used 45 | - name: user.client-certificate 46 | usage: Path to a client certificate file for TLS 47 | - name: user.client-key 48 | usage: Path to a client key file for TLS 49 | - name: user.password 50 | usage: Password for basic authentication to the API server 51 | - name: user.secret-id 52 | usage: SecretID for JWT authentication to the API server 53 | - name: user.secret-key 54 | usage: SecretKey for jwt authentication to the API server 55 | - name: user.token 56 | usage: Bearer token for authentication to the API server 57 | - name: user.username 58 | usage: Username for basic authentication to the API server 59 | example: " # Installing bash completion on macOS using homebrew\n ## If running Bash 3.2 included with macOS\n brew install bash-completion\n ## or, if running Bash 4.1+\n brew install bash-completion@2\n ## If projctl is installed via homebrew, this should start working immediately.\n ## If you've installed via other means, you may need add the completion to your completion directory\n projctl completion bash > $(brew --prefix)/etc/bash_completion.d/projctl\n \n \n # Installing bash completion on Linux\n ## If bash-completion is not installed on Linux, please install the 'bash-completion' package\n ## via your distribution's package manager.\n ## Load the projctl completion code for bash into the current shell\n source <(projctl completion bash)\n ## Write bash completion code to a file and source if from .bash_profile\n projctl completion bash > ~/.iam/completion.bash.inc\n printf \"\n # IAM shell completion\n source '$HOME/.iam/completion.bash.inc'\n \" >> $HOME/.bash_profile\n source $HOME/.bash_profile\n \n # Load the projctl completion code for zsh[1] into the current shell\n source <(projctl completion zsh)\n # Set the projctl completion code for zsh[1] to autoload on startup\n projctl completion zsh > \"${fpath[1]}/_projctl\"" 60 | seeAlso: 61 | - projctl 62 | --------------------------------------------------------------------------------