Skip to content

Commit

Permalink
Merge branch 'main' into bugfix/reviewOutdatedScreenshots-ECC-5926
Browse files Browse the repository at this point in the history
  • Loading branch information
msaipraneeth committed Aug 1, 2023
2 parents 6147c9c + ba659e6 commit aadbcf9
Show file tree
Hide file tree
Showing 168 changed files with 4,481 additions and 342 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
uses: actions/configure-pages@v2

- name: setup python
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: 3.x

Expand All @@ -57,7 +57,7 @@ jobs:

- name: load environment cache
id: cached-poetry-dependencies
uses: actions/cache@v2
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
fetch-depth: "0"

- name: setup python
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: 3.x

Expand All @@ -47,7 +47,7 @@ jobs:

- name: load environment cache
id: cached-poetry-dependencies
uses: actions/cache@v2
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
Expand Down
1 change: 1 addition & 0 deletions .obsidian/core-plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"switcher",
"graph",
"backlink",
"canvas",
"outgoing-link",
"tag-pane",
"page-preview",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: "cmemc: Command Group - admin client"
description: "List client accounts, get or generate client account secrets."
icon: material/account-cog
tags:
- Keycloak
- Security
- cmemc
---
# admin client Command Group
<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->

List client accounts, get or generate client account secrets.

This command group is an opinionated interface to the Keycloak realm of your Corporate Memory instance. In order to be able to use the commands in this group, the configured cmemc connection account needs to be equipped with the `manage-clients` role in the used realm.

Client accounts are identified by a client ID which is unique in the scope of the used realm.

In case your Corporate Memory deployment does not use the default deployment layout, the following additional config variables can be used in your connection configuration: ``KEYCLOAK_BASE_URI`` defaults to `{`CMEM_BASE_URI`}/auth` and locates your Keycloak deployment; ``KEYCLOAK_REALM_ID`` defaults to `cmem` and identifies the used realm.


## admin client list

List client accounts.

```shell-session title="Usage"
$ cmemc admin client list [OPTIONS]
```




Outputs a list of client accounts, which can be used to get an overview as well as a reference for the other commands of the `admin client` command group.

!!! note
The list command only outputs clients which have a client secret. Use the `--raw` option to get a JSON description of all clients.




??? info "Options"
```text

--raw Outputs raw JSON.
--id-only Lists only Client ID. This is useful for piping the IDs into
other commands.
```

## admin client secret

Get or generate a new secret for a client account.

```shell-session title="Usage"
$ cmemc admin client secret [OPTIONS] CLIENT_ID
```




This command retrieves or generates a new secret for a client account from a realm.



??? info "Options"
```text

--generate Generate a new secret
--output Display client secret
```

## admin client open

Open clients in the browser.

```shell-session title="Usage"
$ cmemc admin client open [CLIENT_IDS]...
```




With this command, you can open a client in the keycloak web interface in your browser.

The command accepts multiple client IDs which results in opening multiple browser tabs.



Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,14 @@ With this command, the password of a user account can be changed. The default ex
??? info "Options"
```text

--value TEXT With this option, the new password can be set in a non-
interactive way.
--value TEXT With this option, the new password can be set in a non-
interactive way.

--temporary If enabled, the user must change the password on next login.
--temporary If enabled, the user must change the password on next
login.

--request-change If enabled, will send a email to user to reset the
password.
```

## admin user open
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ tags:
| ------------: | :------ | :---------- |
| [admin](admin/index.md) | [status](admin/index.md#admin-status) | Output health and version information. |
| [admin](admin/index.md) | [token](admin/index.md#admin-token) | Fetch and output an access token. |
| [admin client](admin/client/index.md) | [list](admin/client/index.md#admin-client-list) | List client accounts. |
| [admin client](admin/client/index.md) | [secret](admin/client/index.md#admin-client-secret) | Get or generate a new secret for a client account. |
| [admin client](admin/client/index.md) | [open](admin/client/index.md#admin-client-open) | Open clients in the browser. |
| [admin metrics](admin/metrics/index.md) | [get](admin/metrics/index.md#admin-metrics-get) | Get sample data of a metric. |
| [admin metrics](admin/metrics/index.md) | [inspect](admin/metrics/index.md#admin-metrics-inspect) | Inspect a metric. |
| [admin metrics](admin/metrics/index.md) | [list](admin/metrics/index.md#admin-metrics-list) | List metrics for a specific job. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ This command deletes existing data integration projects from Corporate Memory.
Create projects.

```shell-session title="Usage"
$ cmemc project create PROJECT_IDS...
$ cmemc project create [OPTIONS] PROJECT_IDS...
```


Expand All @@ -193,6 +193,16 @@ This command creates one or more new projects. Existing projects will not be ove



??? info "Options"
```text

--from-transformation TEXT This option can be used to explicitly create the
link specification, which is internally executed
when using the mapping suggestion of a
transformation task. You need the task ID of the
transformation task.
```

## project reload

Reload projects from the workspace provider.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,32 +65,30 @@ With this command, you can execute a workflow that uses variable datasets as inp
??? info "Options"
```text

-i, --input FILE From which file the input is taken: note
that the maximum file size to upload is
limited to a server configured value. If the
-i, --input FILE From which file the input is taken. If the
workflow has no defined variable input
dataset, this can be ignored.
dataset, this option is not allowed.

-o, --output FILE To which file the result is written to: use
-o, --output FILE To which file the result is written to. Use
'-' in order to output the result to stdout.
If the workflow has no defined variable
output dataset, this can be ignored. Please
note that the io command will not warn you
on overwriting existing output files.
output dataset, this option is not allowed.
Please note that the io command will not
warn you on overwriting existing output
files.

--input-mimetype [guess|application/xml|application/json|text/csv]
--input-mimetype [application/x-plugin-csv|application/x-plugin-json|application/xml|application/x-plugin-excel|application/octet-stream|application/x-plugin-multiCsv|text/plain|guess]
Which input format should be processed: If
not given, cmemc will try to guess the mime
type based on the file extension or will
fail
fail.

--output-mimetype [guess|application/xml|application/json|application/n-triples|application/vnd.openxmlformats-officedocument.spreadsheetml.sheet|text/csv]
--output-mimetype [application/x-plugin-csv|application/x-plugin-excel|application/n-triples|application/n-triples|application/x-plugin-json|application/xml|guess]
Which output format should be requested: If
not given, cmemc will try to guess the mime
type based on the file extension or will
fail. In case of an output to stdout, a
default mime type will be used (currently
xml).
default mime type will be used (JSON).

--autoconfig / --no-autoconfig Setup auto configuration of input datasets,
e.g. in order to process CSV files with
Expand Down
Loading

0 comments on commit aadbcf9

Please sign in to comment.