Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into fix/manual-testing-23.1
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/explore-and-author/graph-exploration/index.md
  • Loading branch information
rpietzsch committed Aug 3, 2023
2 parents 59baa9e + e9a29d4 commit 335ae9f
Show file tree
Hide file tree
Showing 297 changed files with 9,740 additions and 1,408 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
2 changes: 1 addition & 1 deletion Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ version: '3'

vars:
PUBLIC_BRANCH: published
CURRENT_VERSION: 22.2
CURRENT_VERSION: 23.1
MATERIAL_TAG: 9.1.4
MATERIAL_INSIDER_TAG: 9.1.4-insiders-4.32.4

Expand Down
23 changes: 23 additions & 0 deletions docs/assets/extra.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/* site specific tweaks */

// hide header and footer for urls that include 'with-your-sandbox'
var header = document.querySelector("header");
var footer = document.querySelector("footer");
let previousUrl = "";

const observer = new MutationObserver(() => {
if (location.href !== previousUrl) {
previousUrl = location.href;
if (location.href?.includes("with-your-sandbox")) {
header.style.display = "none";
footer.style.display = "none";
} else {
header.style.display = "block";
footer.style.display = "block";
}
}
});

const config = { subtree: true, childList: true };
observer.observe(document, config);

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 @@ -24,9 +24,9 @@ $ cmemc admin status [OPTIONS]



This command outputs version and health information of the selected deployment. If the version information can not be retrieved, UNKNOWN shown.
This command outputs version and health information of the selected deployment. If the version information cannot be retrieved, UNKNOWN is shown.

In addition to that, this command warns you if the target version of your cmemc client is newer than the version of your backend and if the ShapeCatalog has a different version then your DataPlatform component.
Additionally, this command warns you if the target version of your cmemc client is newer than the version of your backend and if the ShapeCatalog has a different version than your DataPlatform component.

To get status information of all configured deployments use this command in combination with parallel.

Expand All @@ -40,20 +40,28 @@ $ cmemc config list | parallel --ctag cmemc -c {} admin status
??? info "Options"
```text

--key TEXT Get only specific key(s) from the status / info output.
There are two special keys available: 'all' will list all
available keys in the table, 'overall.healthy' with result
in UP in case all health flags are UP as well (otherwise
DOWN).
--key TEXT Get only specific key(s) from the status /
info output. There are two special keys
available: 'all' will list all available keys
in the table, 'overall.healthy' with result
in UP in case all health flags are UP as
well (otherwise DOWN).

--enforce-table A single value with --key will be returned as plain text
instead of a table with one row and the header. This
default behaviour allows for more easy integration with
scripts. This flag enforces the use of tabular output, even
for single row tables.
--exit-1 [never|error|always] Specify, when this command returns with exit
code 1. Available options are 'never' (exit 0
on errors and warnings), 'error' (exit 1 on
errors, exit 0 on warnings), 'always' (exit 1
on errors and warnings). [default: never]

--raw Outputs combined raw JSON output of the health/info
endpoints.
--enforce-table A single value with --key will be returned as
plain text instead of a table with one row
and the header. This default behaviour allows
for more easy integration with scripts. This
flag enforces the use of tabular output, even
for single row tables.

--raw Outputs combined raw JSON output of the
health/info endpoints.
```

## admin token
Expand All @@ -74,7 +82,7 @@ $ curl -H "Authorization: Bearer $(cmemc -c my admin token)" $(cmemc -c my confi
```


Please be aware that this command can reveal secrets, which you do not want to have in log files or on the screen.
Please be aware that this command can reveal secrets which you might not want to be present in log files or on the screen.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:

List and get metrics.

This command group consists of commands for reading and listing internal monitoring metrics of eccenca Corporate Memory. A deployment consists of multiple jobs (e.g. DP, DI), which provide multiple metric families on an endpoint.
This command group consists of commands for reading and listing internal monitoring metrics of eccenca Corporate Memory. A deployment consists of multiple jobs (e.g. DP, DI), which provide multiple metric families for an endpoint.

Each metric family can consist of different samples identified by labels with a name and a value (dimensions). A metric has a specific type (counter, gauge, summary and histogram) and additional metadata.

Expand Down Expand Up @@ -67,7 +67,7 @@ $ cmemc admin metrics inspect [OPTIONS] METRIC_ID



This command outputs the data of a metric. The first table includes basic meta data about the metric. The second table includes sample labels and values.
This command outputs the data of a metric. The first table includes basic metadata about the metric. The second table includes sample labels and values.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ $ cmemc admin store showcase [OPTIONS]



This command creates a showcase scenario of multiple graphs including integration graphs, shapes, statement annotations etc.
This command creates a showcase scenario of multiple graphs including integration graphs, shapes, statement annotations, etc.

!!! note
There is currently no deletion mechanism for the showcase data, so you need to remove the showcase graphs manually (or just remove all graphs).
There is currently no deletion mechanism for the showcase data and you need to remove the showcase graphs manually (or just remove all graphs).



Expand Down Expand Up @@ -57,10 +57,10 @@ $ cmemc admin store bootstrap [OPTIONS]



This command imports the bootstrap data needed for managing shapes, access conditions, the query catalog and the vocabulary catalog.
This command imports the bootstrap data needed for managing shapes and configuration objects.

!!! note
There is currently no deletion mechanism for the bootstrap data, so you need to remove the graphs manually (or just remove all graphs).
The command will first remove all existing bootstrap data (identified with the isSystemResource flag) and will then import the new data to the corresponding graphs (shape catalog, vocabulary catalog, configuration graph).



Expand All @@ -83,7 +83,7 @@ $ cmemc admin store export [OPTIONS] BACKUP_FILE



The backup file is a ZIP archive containing all knowledge graphs as Turtle files + configuration file for each graph.
The backup file is a ZIP archive containing all knowledge graphs (one Turtle file + configuration file per graph).

This command will create lots of load on the server. It can take a long time to complete.

Expand All @@ -107,11 +107,11 @@ $ cmemc admin store import BACKUP_FILE



The backup file is a ZIP archive containing all knowledge graphs as Turtle files + configuration file for each graph.
The backup file is a ZIP archive containing all knowledge graphs (one Turtle file + configuration file per graph).

The command will load a single backup ZIP archive into the triple store, by replacing all graphs with the content of the Turtle files in the archive and deleting all graphs which are not in the archive.
The command will load a single backup ZIP archive into the triple store by replacing all graphs with the content of the Turtle files in the archive and deleting all graphs which are not in the archive.

This command will create lots of load on the server. It can take a long time to complete. The backup file will be transferred to the server, then unzipped and imported graph by graph. After the initial transfer, the network connection is not used anymore, so it will be closed by proxies sometimes. This does not mean that the import failed.
This command will create lots of load on the server. It can take a long time to complete. The backup file will be transferred to the server, then unzipped and imported graph by graph. After the initial transfer the network connection is not used anymore and may be closed by proxies. This does not mean that the import failed.



Loading

0 comments on commit 335ae9f

Please sign in to comment.