{"id":18896393,"url":"https://github.com/openmainframeproject/software-discovery-tool-deploy","last_synced_at":"2026-02-28T05:30:15.593Z","repository":{"id":40483544,"uuid":"392352963","full_name":"openmainframeproject/software-discovery-tool-deploy","owner":"openmainframeproject","description":"View the live deployed version of SDT maintained by OMP","archived":false,"fork":false,"pushed_at":"2024-07-17T22:05:18.000Z","size":28,"stargazers_count":0,"open_issues_count":6,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-12-31T08:14:15.210Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://sdt.openmainframeproject.org/sdt/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openmainframeproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-03T14:54:00.000Z","updated_at":"2024-05-28T16:48:59.000Z","dependencies_parsed_at":"2024-11-08T08:35:17.668Z","dependency_job_id":"2f5cd97c-c384-4e1d-9b27-5ca67d736c0d","html_url":"https://github.com/openmainframeproject/software-discovery-tool-deploy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsoftware-discovery-tool-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsoftware-discovery-tool-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsoftware-discovery-tool-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsoftware-discovery-tool-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openmainframeproject","download_url":"https://codeload.github.com/openmainframeproject/software-discovery-tool-deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239871075,"owners_count":19710841,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T08:33:45.763Z","updated_at":"2026-02-28T05:30:15.543Z","avatar_url":"https://github.com/openmainframeproject.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bootstrapping the Software Discovery Tool Deployment Repository\n## Introduction\nThis guide will walk you through the process of setting up the Software Discovery Tool deployment repository from scratch on an Ubuntu system. We'll use submodules to include the main repository and the data repository within the deployment repository.\n\n## What are Submodules?\nSubmodules in Git allow you to include other Git repositories as subdirectories of your own repository. In our case, we use submodules to include the main Software Discovery Tool repository and the data repository within the deployment repository.\n\n# Step-by-Step Instructions\n1. Install Ubuntu:\nFollow the installation instructions for Ubuntu on your virtual machine (VM) [Link](https://ubuntu.com/tutorials/how-to-run-ubuntu-desktop-on-a-virtual-machine-using-virtualbox#1-overview)\n\n2. Clone the Deployment Repository:\nUse the following command to clone the deployment repository and its submodules:\n```sudo git clone --recurse-submodules https://github.com/openmainframeproject/software-discovery-tool-deploy.git /opt/software-discovery-tool-deploy```\nThis command will clone the deployment repository and automatically initialize and update all submodules.\n\n3. Create Symbolic Link:\nCreate a symbolic link to the Software Discovery Tool directory:\n```sudo ln -s /opt/software-discovery-tool-deploy/software-discovery-tool/ /opt/software-discovery-tool\n```\nThis command creates a symbolic link named `/opt/software-discovery-tool` pointing to the `software-discovery-tool` directory within the deployment repository.\n\n# Directory Structure\nAfter completing the above steps, your directory structure should resemble the following:\n```\n/opt/\n├── software-discovery-tool-deploy/   # Deployment repository\n│   ├── software-discovery-tool/      # Main repository (submodule)\n│   └── data/                          # Data repository (submodule)\n└── software-discovery-tool/          # Symbolic link to the Software Discovery Tool directory\n```\n\n\n# How To Deploy\nThe whole SDT deployment is maintained by:\n- [cicd.yml](https://github.com/rachejazz/software-discovery-tool-deploy/blob/main/.github/workflows/cicd.yml) workflow\n- [config_build.py](https://github.com/openmainframeproject/software-discovery-tool/blob/master/bin/config_build.py) to create new sections in the distro config file\n- [package_build.py](https://github.com/openmainframeproject/software-discovery-tool/blob/master/bin/package_build.py) to update existing distro files to latest versions\n\n# Contribute to the deployment workflow\n\n## Contribute to deployment script\nThe deployment uses [appleboy's ssh workflow](https://github.com/appleboy/ssh-action)\nThe deployment is thus triggered at every new pusb into the main branch.\nThe script section uses the required server credentials to be able to host the tool.\n```yml\nscript: |\n          cd /opt/software-discovery-tool-deploy\n          sudo chown -R sdtuser .\n          git checkout main\n          git pull origin main --recurse-submodules\n          sudo cp -u -r software-discovery-tool/ ../software-discovery-tool/\n          [cicd.yml](https://github.com/rachejazz/software-discovery-tool-deploy/blob/main/.github/workflows/cicd.yml)\n```\nIt includes \n- Pulling the latest changes\n- Copies the contents to the main directory\n- Uses config_build.py to check for new data files\n- Uses package_build.py to update the existing files with the recent pkg versions\n- Restart the server\n\n## Contribute to package_build.py\nThe binary has separate methods to extract data from Linux Distributions and [PDS]().\nCheck [SDT-data]() repo to find out the distro list we support.\n\n## Contribute to config_build.py\nThis file controls the `supported_distro.py` file that resides inside `src/config` directory.\nIt checks for any new data file inside `distro_files` directory and adds it's mapping to the `supported_distro.py`.\nAny existing data file from PDS is updated from upstream.\n\n\n_NOTE_\nAny contribution to the binary should be done in the main repository.\n\n# Report bugs and issues\nFeel free to add new issues or features that you would like SDT to support.\nBugs are given high priority since this is an active project used by users of IBM zSystems and LinuxONE .\n\nFor deployment improvements, use this repository.\nFor new feature request to SDT, use the [main repository](https://github.com/openmainframeproject/software-discovery-tool).\nFor new data files request, use the [data repository](https://github.com/openmainframeproject/software-discovery-tool-data).\n\nAppreciating all the contributions that you do for the Open Mainframe Project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmainframeproject%2Fsoftware-discovery-tool-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenmainframeproject%2Fsoftware-discovery-tool-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmainframeproject%2Fsoftware-discovery-tool-deploy/lists"}