From 2c1258f90ff76fb94c9b7af8a371ad491636f48a Mon Sep 17 00:00:00 2001 From: Laurent GRATEAU Date: Fri, 28 Jun 2024 09:45:32 +0200 Subject: [PATCH] Vnext release (#54) * Decisions convergence (#48) * Implement support for both Decisions products and refactoring - Made service compatible with ODM and ADS - Integrated metering model for simplified dependencies - Renamed packages, options, produced jar file - Adapted, refactored and reviewed documentation accordingly * Update copyright notices * Deliver next release - 8.12.0 (#45) * Switch to the next version * Change copyright year: DBACLD-90119 * Pre delivery 812 (#44) * Prepare new release. * increase time to run test * Change liberty version for the next release * Use a pre-deploy ruleset * Adapt test after moving to the new rule set * Prepare next delivery * Update Chart.yaml - Fix bad odm version * fix bad version * Update test.sh * Update docker-compose.yml Try to add network * Update docker-compose.yml - Remove network * Update build-and-test.yml * Update build-and-test.yml debug * Update test.sh * Update test.sh * Take the new jar file name into account * Trigger new action build --------- Co-authored-by: Anthony Acremann * Prepare next release * Update Liberty version * Update build-and-test.yml * Update build-and-test.yml * Update build-and-test.yml - Revert * Bad reference url * Update build-and-test.yml - Change Liberty version * Change for the next release * Update build-and-test.yml * Try to workaround issue DBACLD-118818 * Fix location * Update Chart.yaml * Update values.yaml * Update values.yaml * Move to the new release name 9.0.0 * Linter failed * DBACLD-125217 Metering service does not store correctly the metrics * Override delivery to fix issue * New description for the dockerjub * DBACLD-125376 Change copyright * Dbacld 125217 (#50) * Fix configuration of the service * DBACLD-125217 * Try to fix Github action * Fix initVariable syntax * Fix shell syntax. * no message * Debug * Fix metrics check * Move to JDK 17 * improve logging * DBACLD-134790 Change License for the next release * Prepare next release * Preprare next release * Prepare next release * Update README_ODM.md * Update Chart.yaml * Update kuberentes version * Fix Kubernetes requirement * Change home url + Kubernetes version * Try to add artifacthub verified status * Add markdown link check (#53) * DBACLD-139987 - Put in place checker link * ignore some broken links * ignore broken links with localhost URL --------- Co-authored-by: Frederic Mercier * Fix broken link * Fix broken link --------- Co-authored-by: Anthony Acremann Co-authored-by: Frederic Mercier Co-authored-by: Frederic Mercier --- .github/workflows/check-links.yml | 25 +++++++++++++++++++++++++ .md_check_config.json | 14 ++++++++++++++ README.md | 2 +- docker/dockerhub/full-description.md | 8 +++++--- topics/dssetup.md | 2 +- 5 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/check-links.yml create mode 100644 .md_check_config.json diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..2ea6949 --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,25 @@ +name: Check Markdown links + +#on: +# push: +# branches: +# - master +# pull_request: +# branches: [master] +on: push +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: technote-space/get-diff-action@v6 + with: + PATTERNS: | + **/**.md + + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: '.md_check_config.json' + diff --git a/.md_check_config.json b/.md_check_config.json new file mode 100644 index 0000000..17934a0 --- /dev/null +++ b/.md_check_config.json @@ -0,0 +1,14 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http://localhost" + } + ], + "replacementPatterns": [ + { + "pattern": "^/LICENSE", + "replacement": "{{BASEURL}}/LICENSE" + } + ], + "timeout": "20s" + } \ No newline at end of file diff --git a/README.md b/README.md index 041718d..7dcff0a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IBM Decisions usage metering service -[IBM License Metric Tool](https://www.ibm.com/support/knowledgecenter/SS8JFY_9.2.0/com.ibm.lmt.doc/welcome/LMT_welcome.html) inventories IBM software, and monitors its usage and compliance. The Decisions usage metering service produces license files that are compliant with the tool and based on the observed usage of IBM Decisions software. +[IBM License Metric Tool](https://www.ibm.com/docs/en/license-metric-tool) inventories IBM software, and monitors its usage and compliance. The Decisions usage metering service produces license files that are compliant with the tool and based on the observed usage of IBM Decisions software. ## IBM Operational Decision Manager To configure metering for use with IBM Operation Decision Manager, see the following documentation:[ODM Readme](README_ODM.md) diff --git a/docker/dockerhub/full-description.md b/docker/dockerhub/full-description.md index 0cc7481..cb74b80 100644 --- a/docker/dockerhub/full-description.md +++ b/docker/dockerhub/full-description.md @@ -35,7 +35,7 @@ docker pull icr.io/cpopen/odm-k8s/odm-metering-service:9.0-amd64 # Overview -The Operational Decision Manager (ODM) usage metering service image allows you to generate license files that are compliant with the [IBM License Metric Tool](https://www.ibm.com/support/knowledgecenter/SS8JFY_9.2.0/com.ibm.lmt.doc/welcome/LMT_welcome.html). These license files are based on the observed usage of ODM software. +The Operational Decision Manager (ODM) usage metering service image allows you to generate license files that are compliant with the [IBM License Metric Tool](https://www.ibm.com/docs/en/license-metric-tool). These license files are based on the observed usage of ODM software. See the License section at the end of this page for restrictions on the use of this image. @@ -49,18 +49,20 @@ You must accept the license before you launch the image. The license is availabl docker run -e LICENSE=accept -p 8888:8888 -p 9999:9999 icr.io/cpopen/odm-k8s/odm-metering-service:9.0-amd64 ``` -When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page. +When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page. The metering service receives usage information from Operational Decision Manager and aggregates it. When the service is available, you can get a zip archive of the ILMT files by using the /backup REST API endpoint. -In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup +In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup or use the following curl command: + ```console curl http://localhost:8888/backup -o backup.zip curl -k https://localhost:9999/backup -o backup.zip ``` + ## Storage diff --git a/topics/dssetup.md b/topics/dssetup.md index 9398394..46c7225 100644 --- a/topics/dssetup.md +++ b/topics/dssetup.md @@ -15,7 +15,7 @@ Among the parameters listed in the res-setup task document, the following parame Parameter | Description :-: | :-: metering.api.key | This parameter is not used, but it is mandatory. Use an arbitrary value. -metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service. +metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service. metering.enable | To be set to true so that the metering components can run. metering.send.usages | To be set to true so that actual usages are sent to the metering service. metering.instance.identifier | If specified, it is used as a reference to identify a metering client instance within Operational Decision Manager. This information appears in the log of the metering service, so it is recommended to be customized.