Merge branch 'main' into feature/helm-deployment

Signed-off-by: Thomas Telleis <[email protected]>

Author: sobo

.github/workflows/pages.yml

@@ -75,12 +75,12 @@ jobs:
         run: task clean build
 
       - name: upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           # Upload entire repository
           path: 'site'
 
       - name: deploy to gitHub pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4
 

CONTRIBUTING.md

@@ -94,6 +94,11 @@ Have a look at the [mkdocs-material documentation](https://squidfunk.github.io/m
 
 </details>
 
+## Icons
+
+Where possible, please use icons as described on [the material for mkdocs documention](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/).
+On this page is search function for icons available as well.
+
 ## Admonitions
 
 <details>

README.md

@@ -13,7 +13,7 @@ If you consider to contribute to this project, please have a look on [CONTRIBUTI
 
 ## License
 
-Copyright © 2024 [eccenca GmbH](https://eccenca.com)
+Copyright © 2025 [eccenca GmbH](https://eccenca.com)
 
 This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
 

Taskfile.yml

@@ -5,9 +5,9 @@ version: '3'
 
 vars:
   PUBLIC_BRANCH: published
-  CURRENT_VERSION: 24.1
-  MATERIAL_TAG: 9.5.17
-  MATERIAL_INSIDER_TAG: 9.5.17-insiders-4.53.6
+  CURRENT_VERSION: 25.2
+  MATERIAL_TAG: 9.6.14
+  MATERIAL_INSIDER_TAG: 9.6.14-insiders-4.53.16
 
 tasks:
 
@@ -108,7 +108,7 @@ tasks:
     desc: re-generates the cmemc command reference
     cmds:
       - rm -rf {{.REFERENCE_DIR}}/*
-      - CMEMC_MANUAL_DIR={{.REFERENCE_DIR}} cmemc -q config
+      - cmemc manual --format markdown-multi-page --output-dir {{.REFERENCE_DIR}}
     vars:
       REFERENCE_DIR: docs/automate/cmemc-command-line-interface/command-reference
 

docs/assets/extra.css

@@ -163,3 +163,43 @@ img.bordered {
     margin-top: 0.125em;
 }
 
+/**
+ * simplify layout for print:
+ * - only use logo and page title from header
+ * - remove footer completely
+ * - remove whitespace around main content
+ * - remove comment section
+ */
+@media print {
+    body {
+        background-color: transparent;
+    }
+    .md-header {
+        box-shadow: none;
+        background-color: transparent;
+    }
+    .md-header__inner {
+        padding: 0;
+        margin: 0 0.8rem;
+        max-width: none;
+    }
+    .md-header__inner > * {
+        display: none !important;
+    }
+    .md-header__inner > .md-logo,
+    .md-header__inner > .md-header__title {
+        display: inline-block !important;
+        margin: 0;
+    }
+
+    .md-footer {
+        display: none !important;
+    }
+    .md-main__inner {
+        max-width: none;
+        margin: 0;
+    }
+    #__comments, .giscus {
+        display: none !important;
+    }
+}

docs/automate/cmemc-command-line-interface/command-reference/admin/acl/index.md

@@ -71,20 +71,40 @@ $ cmemc admin acl create [OPTIONS]
 
 
 
+With this command, new access conditions can be created.
+
+An access condition captures information about WHO gets access to WHAT. In order to specify WHO gets access, use the ``--user`` and / or ``--group`` options. In order to specify WHAT an account get access to, use the ``--read-graph``, ``--write-graph`` and ``--action`` options.`
+
+In addition to that, you can specify a name, a description and an ID (all optional).
+
+A special case are dynamic access conditions, based on a SPARQL query: Here you have to provide a query with the projection variables `user`, `group` `readGraph` and `writeGraph` to create multiple grants at once. You can either provide a query file or a query URL from the query catalog.
+
+!!! note
+    Queries for dynamic access conditions are copied into the ACL, so changing the query in the query catalog does not change it in the access condition.
+
+
+```shell-session title="Example"
+$ cmemc admin acl create --group local-users --write-graph https://example.org/
+```
+
+
+
 
 ??? info "Options"
     ```text
 
-    --name TEXT         A short name or label.
-    --id TEXT           An optional ID (will be an UUID otherwise).
-    --description TEXT  An optional description.
     --user TEXT         A specific user account required by the access
                         condition.
     --group TEXT        A membership in a user group required by the access
-                        condition
+                        condition.
     --read-graph TEXT   Grants read access to a graph.
     --write-graph TEXT  Grants write access to a graph (includes read access).
     --action TEXT       Grants usage permissions to an action / functionality.
+    --query TEXT        Dynamic access condition query (file or the query
+                        catalog IRI).
+    --id TEXT           An optional ID (will be an UUID otherwise).
+    --name TEXT         A optional name.
+    --description TEXT  An optional description.
     ```
 
 ## admin acl update
@@ -105,15 +125,17 @@ Given an access condition URL, you can change specific options to new values.
 ??? info "Options"
     ```text
 
-    --name TEXT         A short name or label.
+    --name TEXT         A optional name.
     --description TEXT  An optional description.
     --user TEXT         A specific user account required by the access
                         condition.
     --group TEXT        A membership in a user group required by the access
-                        condition
+                        condition.
     --read-graph TEXT   Grants read access to a graph.
     --write-graph TEXT  Grants write access to a graph (includes read access).
     --action TEXT       Grants usage permissions to an action / functionality.
+    --query TEXT        Dynamic access condition query (file or the query
+                        catalog IRI).
     ```
 
 ## admin acl delete
@@ -153,7 +175,7 @@ $ cmemc admin acl review [OPTIONS] USER
 
 
 
-This command has two working modes: (1) You can review the access conditions of an actual account - this needs access to keycloak and the access condition API, (2) You can review the access conditions of an imaginary account with a set of freely added groups (what-if-scenario) - this only needs access to the access condition API.
+This command has two working modes: (1) You can review the access conditions of an actual account, (2) You can review the access conditions of an imaginary account with a set of freely added groups (what-if-scenario).
 
 The output of the command is a list of grants the account has based on your input and all access conditions loaded in the store. In addition to that, some metadata of the account is shown.
 

docs/automate/cmemc-command-line-interface/command-reference/admin/index.md

@@ -26,7 +26,7 @@ $ cmemc admin status [OPTIONS]
 
 This command outputs version and health information of the selected deployment. If the version information cannot be retrieved, UNKNOWN is shown.
 
-Additionally, this command informs you in one of these cases: (1) A warning, if the target version of your cmemc client is newer than the version of your backend. (2) A warning, if the ShapeCatalog has a different version than your DataPlatform component. (3) An error, if your Corporate Memory license is expired (grace period). (4) A warning, if your Graph DB license will expire in less than a month.
+Additionally, this command informs you in one of these cases: (1) A warning, if the target version of your cmemc client is newer than the version of your backend. (2) A warning, if the ShapeCatalog has a different version than your Explore component. (3) An error, if your Corporate Memory license is expired (grace period). (4) A warning, if your Graph DB license will expire in less than a month.
 
 To get status information of all configured deployments use this command in combination with parallel.
 

docs/automate/cmemc-command-line-interface/command-reference/admin/metrics/index.md

@@ -35,8 +35,6 @@ A metric of a specific job is identified by a metric ID. Possible metric IDs of
 ??? info "Options"
     ```text
 
-    --job [DP]               The job from which the metrics data is fetched.
-                             [default: DP]
     --filter <TEXT TEXT>...  A set of label name/value pairs in order to filter
                              the samples of the requested metric family. Each
                              metric has a different set of labels with different
@@ -71,7 +69,6 @@ This command outputs the data of a metric. The first table includes basic metada
 ??? info "Options"
     ```text
 
-    --job [DP]  The job from which the metrics data is fetched.  [default: DP]
     --raw       Outputs raw JSON of the table data.
     ```
 
@@ -93,9 +90,11 @@ For each metric, the output table shows the metric ID, the type of the metric, a
 ??? info "Options"
     ```text
 
-    --job [DP]  The job from which the metrics data is fetched.  [default: DP]
-    --id-only   Lists metric identifier only. This is useful for piping the IDs
-                into other commands.
-    --raw       Outputs (sorted) JSON dict, parsed from the metrics API output.
+    --filter <TEXT TEXT>...  Filter metrics by one of the following filter names
+                             and a corresponding value: job, name, type, id.
+    --id-only                Lists metric identifier only. This is useful for
+                             piping the IDs into other commands.
+    --raw                    Outputs (sorted) JSON dict, parsed from the metrics
+                             API output.
     ```
 

docs/automate/cmemc-command-line-interface/command-reference/admin/migration/index.md

@@ -0,0 +1,75 @@
+---
+title: "cmemc: Command Group - admin migration"
+description: "List and apply migration recipes."
+icon: material/database-arrow-up-outline
+tags:
+  - cmemc
+---
+# admin migration Command Group
+<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->
+
+List and apply migration recipes.
+
+With this command group, you can check your instance for needed migration activities as well as apply them to your data.
+
+Beside an ID and a description, migration recipes have the following metadata: 'First Version' is the first Corporate Memory version, where this recipe is maybe applicable. The recipe will never be applied to a version below this version. 'Tags' is a classification of the recipe with regard to the target data, it migrates.
+
+The following tags are important: `system` recipes target data structures which are needed to run the most basic functionality properly. These recipes can and should be applied after each version upgrade. `user` recipes can change user and / or customizing data. `acl` recipes migrate access condition data. `shapes` recipes migrate shape data. `config` recipes migrate configuration data.
+
+
+## admin migration list
+
+List migration recipies.
+
+```shell-session title="Usage"
+$ cmemc admin migration list [OPTIONS]
+```
+
+
+
+
+This command lists all available migration recipies
+
+
+
+??? info "Options"
+    ```text
+
+    --filter <TEXT TEXT>...  Filter migration recipes by one of the following
+                             filter names and a corresponding value: id,
+                             description, first_version, tag.
+    --id-only                Lists only IDs. This is useful for piping the IDs
+                             into other commands.
+    --raw                    Outputs raw JSON.
+    ```
+
+## admin migration execute
+
+Execute needed migration recipes.
+
+```shell-session title="Usage"
+$ cmemc admin migration execute [OPTIONS] [MIGRATION_ID]
+```
+
+
+
+
+This command executes one or more migration recipes. Each recipe has a check method to determine if a migration is needed. In addition to that, the current component version needs to match the specified first-last-version range of the recipe.
+
+Recipes are executed ordered by first_version.
+
+Here are some argument examples, in order to see how to use this command: execute `--all` `--test-only` will list all needed migrations (but not execute them), execute `--filter` tag system will apply all migrations which target system data, execute bootstrap-data will apply bootstrap-data migration if needed.
+
+
+
+??? info "Options"
+    ```text
+
+    --filter <TEXT TEXT>...  Filter migration recipes by one of the following
+                             filter names and a corresponding value: id,
+                             description, first_version, tag.
+    -a, --all                Execute all needed migrations.
+    --test-only              Only test, do not execute migrations.
+    --id-only                Lists only recipe identifier.
+    ```
+

docs/automate/cmemc-command-line-interface/command-reference/admin/store/index.md

@@ -63,6 +63,10 @@ Use ``--remove`` to delete bootstrap data.
     The removal of existing bootstrap data will search for resources which are flagged with the isSystemResource property.
 
 
+!!! note
+    The import part of this command is equivalent to the 'bootstrap-data' migration recipe
+
+
 
 
 ??? info "Options"
@@ -78,7 +82,7 @@ Use ``--remove`` to delete bootstrap data.
 Backup all knowledge graphs to a ZIP archive.
 
 ```shell-session title="Usage"
-$ cmemc admin store export [OPTIONS] BACKUP_FILE
+$ cmemc admin store export [OPTIONS] [BACKUP_FILE]
 ```
 
 
@@ -93,8 +97,8 @@ This command will create lots of load on the server. It can take a long time to
 ??? info "Options"
     ```text
 
-    --overwrite  Overwrite existing files. This is a dangerous option, so use it
-                 with care.
+    --replace   Replace existing files. This is a dangerous option, so use it
+                with care.
     ```
 
 ## admin store import
@@ -116,3 +120,24 @@ This command will create lots of load on the server. It can take a long time to
 
 
 
+## admin store migrate
+
+Migrate configuration resources to the current version.
+
+```shell-session title="Usage"
+$ cmemc admin store migrate [OPTIONS]
+```
+
+
+
+
+This command serves two purposes: (1) When invoked without an option, it lists all migrateable configuration resources. (2) When invoked with the ``--workspaces`` option, it migrates the workspace configurations to the current version.
+
+
+
+??? info "Options"
+    ```text
+
+    --workspaces  Migrate workspace configurations to the current version.
+    ```
+