Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Blog
  • Questions
  • Learning
    • E-learning Courses
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Tutorials
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • DataMiner Insights
      • Security
      • Integration Studio
      • System Architecture
      • DataMiner Releases & Updates
      • DataMiner Apps
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
  • Downloads
  • More
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
      • General Inquiries
      • DataMiner DevOps Support
      • Commercial Requests
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

[CICD] – dataminer-package-deploy failure with dmprotocol package

Solved323 views24th February 2025CICD
2
Kévin Dugué [DevOps Advocate]263 19th February 2025 0 Comments

Hi,

I previsouly created a CICD pipeline with muliple steps like building solution, creating DMAPP package, uploading DMAPP package and deploying DMAPP package with success (using secret key).

Now i am trying to do the same but with a connector/protocol solution.

- name: Create protocol package
if: github.ref_type == 'branch'
run: dataminer-package-create dmprotocol "${{ github.workspace }}/Protocol" --output "${{ github.workspace }}" --name "test"

- name: Upload protocol
id: UploadDmprotocol
run: |
echo "uploadOutput=$(dataminer-catalog-upload --path-to-artifact "${{ github.workspace }}/test.dmprotocol" --dm-catalog-token ${{ secrets.DATAMINER_DEPLOY_KEY }})" >> $GITHUB_OUTPUT
shell: bash

- name: Deploy protocol
run: |
dataminer-package-deploy from-catalog --artifact-id "${{ steps.UploadDmprotocol.outputs.uploadOutput }}" --dm-catalog-token "${{ secrets.DATAMINER_DEPLOY_KEY }}" --debug

For the last step "Deploy protocol", the deployment always fails. I don't have details of the error (even with --debug option).

Run dataminer-package-deploy from-catalog --artifact-id "[15:52:50 INF] {"artifactId":"dmscript/ac35a155-bfd9-4080-9c47-fbf8c49914b5"}" --dm-catalog-token "***" --debug

8[15:52:54 DBG] Attempting deployment with provided argument as token for artifact: dmscript/ac35a155-bfd9-4080-9c47-fbf8c49914b5...

9[15:52:54 DBG] Deploying dmscript/ac35a155-bfd9-4080-9c47-fbf8c49914b5

10[15:52:54 DBG] Deployment c7cf102c-2efb-4976-a780-9dc9d969a95e started...

11[15:52:54 DBG] Deployment started...

12[15:52:54 DBG] Waiting 3s before checking deployment status.

13[15:52:57 DBG] Checking deployment status...

14[15:52:58 FTL] Deployment Failed with status Error for artifact dmscript/ac35a155-bfd9-4080-9c47-fbf8c49914b5.

15[15:52:58 DBG] Deployment finished.

16[15:52:58 INF] {"Status":"Error"}

17[15:52:58 FTL] Fail-Deployment returned false

18Error: Process completed with exit code 1.

If anyone can help me resolve this error, I'd appreciate it.

Thanks

Kévin Dugué [DevOps Advocate] Selected answer as best 24th February 2025

1 Answer

  • Active
  • Voted
  • Newest
  • Oldest
2
Avatar photo
Jan Staelens [SLC] [DevOps Advocate]889 Posted 21st February 2025 3 Comments

Apologies for the delay in responding. I wanted to ensure that I could provide you with a useful update, so my team and I re-prioritized QA and the release of a new version of the Deployer Tool. This update provides a workaround for your current issue.
Issue Acknowledgment & Upcoming Fix
First of all, thank you for reporting this. It helped us identify a gap in our current implementation. At the moment, performing a volatile upload of a *.dmprotocol item and then attempting to deploy it is not supported, as the necessary code does not yet exist.

I have discussed this internally, and we plan to introduce support for this within the next month. Once available, I will follow up to confirm the update, at which point your CI/CD pipeline should function as expected.
Workaround: Deploying from Catalog
In the meantime, we have released a new version of the dataminer-package-deploy tool that allows deployments directly from a registered catalog item. As a workaround, you can first perform a registered upload (note: this will make the version visible in the Catalog UI) and then deploy from the Catalog using the new functionality.

  • Registered Upload Documentation:
    Catalog Upload Tool – Registered Uploads
  • Deploying from the Catalog Documentation:
    DataMiner Deploy Tool – Deploying from Catalog

Pipeline Adjustments
If you choose to apply this workaround, your CI/CD pipeline should be updated as follows:

<code class="language-yaml">name: DataMiner CICD Connector Deploy Only

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the master branch
  push:
    branches: []
    tags:
      - "[0-9]+.[0-9]+.[0-9]+.[0-9]+"
      - "[0-9]+.[0-9]+.[0-9]+.[0-9]+-**"

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:

   # Optional 0 or More CD Jobs as needed
  CD:
   # if: github.ref_type == 'tag'
    environment: development
    name: CD
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install .NET Tools
        run: |
          dotnet tool install -g Skyline.DataMiner.CICD.Tools.Packager
          dotnet tool install -g Skyline.DataMiner.CICD.Tools.CatalogUpload
          dotnet tool install -g Skyline.DataMiner.CICD.Tools.DataMinerDeploy

      - name: Create protocol package
        if: github.ref_type == 'branch'
        run: dataminer-package-create dmprotocol "${{ github.workspace }}" --output "${{ github.workspace }}" --name "test"

      - name: Upload protocol to Catalog
        id: UploadDmprotocol
        shell: pwsh
        run: |
          dataminer-catalog-upload with-registration --path-to-artifact "${{ github.workspace }}/test.dmprotocol" `
          --catalog-identifier "TODO:Add a GUID" `
          --uri-sourcecode "https://github.com/${{ github.repository }}" `
          --artifact-version "0.0.${{ github.run_number }}-prerelease" `
          --dm-catalog-token ${{ secrets.DATAMINER_DEPLOY_KEY }}

      - name: Deploy protocol
        shell: pwsh
        run: |
          dataminer-package-deploy from-catalog --catalog-id "TODO:Add SAME GUID" `
          --catalog-version "0.0.${{ github.run_number }}-prerelease" `
          --agent-destination-id "TODO: SEE BELOW" `
          --dm-catalog-token ${{ secrets.DATAMINER_DEPLOY_KEY }}
</code>

Important Considerations:

  • This approach will make each upload visible in the Catalog UI, which may not be ideal for build or pre-release testing.
  • The token/key used for deployment must be an Organization Key rather than a key from a specific DataMiner system.

Deployment Parameters & Configuration

  • dm-catalog-token: Must be an Organization Key with permissions to deploy a version of a catalog item.
  • catalog-id: The GUID of the catalog item you wish to deploy. This should match the ID used during registration. To find an existing catalog item’s ID, navigate to its details page in the Catalog (it is the last part of the URL).
  • catalog-version: The specific version number of the catalog item to deploy.
  • agent-destination-id: The identifier of the target DataMiner system. This can be found in the Admin app, where it appears as the last GUID in the system’s details page URL.

You can find a working example of this workflow here:

https://github.com/SkylineCommunications/BoostTestConnector/actions/workflows/dataminer-cicd-connector-deployonly.yml

If you have any further questions or encounter any issues, feel free to reach out. I will update you once the planned fix for volatile uploads is implemented.

Kévin Dugué [DevOps Advocate] Selected answer as best 24th February 2025
Kévin Dugué [DevOps Advocate] commented 24th February 2025

Hi Jan,

Thanks, i tried your workaround using catalog instead of volatile deployment.
I used an organization key as secret for the "upload" and "deploy" steps.

The "upload to catalog" step seems to fail : error 401.
I can see my prerelease version in catalog UI, but the button "deploy" is disabled.

I noticed that you have the same error than me wih the example provided
https://github.com/SkylineCommunications/BoostTestConnector/actions/runs/13455879227/job/37599684591

Run dataminer-catalog-upload with-registration –path-to-artifact "/home/runner/work/BoostTestConnector/BoostTestConnector/test.dmprotocol" `
dataminer-catalog-upload with-registration –path-to-artifact "/home/runner/work/BoostTestConnector/BoostTestConnector/test.dmprotocol" `
–catalog-identifier "8f3c95c5-7da4-4567-9759-40f459ac1c09" `
–uri-sourcecode "https://github.com/SkylineCommunications/BoostTestConnector&quot; `
–artifact-version "0.0.10-prerelease" `
–dm-catalog-token ***
shell: /usr/bin/pwsh -command ". '{0}'"
[11:30:05 ERR] The upload api returned a Unauthorized response. Body: { "statusCode": 401, "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." }
[11:30:05 INF] {"artifactId":""}

Avatar photo
Jan Staelens [SLC] [DevOps Advocate] commented 24th February 2025

Hi, indeed but u can ignore that error. The upload worked and you should be able to deploy with it successfully. The upload tool returns a, exit code '0' meaning it ran correctly. The error is a false positive, I'll look into a new version that avoids it getting logged and causing confusion. I'm uncertain why the Deploy Button would be greyed out in your Catalog UI though.

Kévin Dugué [DevOps Advocate] commented 24th February 2025

Hi, yes indeed it is a false positive, it works. The main Deploy button is greyed out at the top right, but as the button is enabled when selecting a specific version in "Version history" tab, it's fine.

You are viewing 1 out of 1 answers, click here to view all answers.
Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas

Recent questions

Alarm Dashboard PDF/CSV Export 0 Answers | 0 Votes
Is the Microsoft SharePoint Connector Still Usable 0 Answers | 0 Votes
Is the Microsoft SharePoint Connector Still Usable 0 Answers | 0 Votes

Question Tags

adl2099 (115) alarm (62) Alarm Console (82) alarms (100) alarm template (83) Automation (223) automation scipt (111) Automation script (167) backup (71) Cassandra (180) Connector (108) Correlation (68) Cube (150) Dashboard (194) Dashboards (188) database (83) DataMiner Cube (57) DIS (81) DMS (71) DOM (139) driver (65) DVE (55) Elastic (83) Elasticsearch (115) elements (80) Failover (104) GQI (159) HTTP (76) IDP (74) LCA (151) low code app (166) low code apps (93) lowcodeapps (75) MySQL (53) protocol (203) QAction (83) security (88) services (51) SNMP (86) SRM (337) table (54) trending (87) upgrade (62) Visio (539) Visual Overview (345)
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs

[ Placeholder content for popup link ] WordPress Download Manager - Best Download Management Plugin