{"id":43435872,"url":"https://github.com/mozilla-releng/tooltool","last_synced_at":"2026-02-02T20:53:33.020Z","repository":{"id":38324241,"uuid":"214164415","full_name":"mozilla-releng/tooltool","owner":"mozilla-releng","description":"Tasks in the RelEng infrastructure and make use of generic binary artifacts, which are stored in dedicated artifacts repositories (S3 buckets). ToolTool application provides an interface to those artifacts repositories.","archived":false,"fork":false,"pushed_at":"2026-01-27T12:15:44.000Z","size":1257,"stargazers_count":0,"open_issues_count":7,"forks_count":14,"subscribers_count":4,"default_branch":"master","last_synced_at":"2026-01-27T22:36:15.440Z","etag":null,"topics":["backend","frontend","openapi","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mozilla-releng.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-10-10T11:26:24.000Z","updated_at":"2026-01-27T11:59:43.000Z","dependencies_parsed_at":"2023-02-18T02:45:24.765Z","dependency_job_id":"b8b18777-1b01-4536-895d-dd9394788a6c","html_url":"https://github.com/mozilla-releng/tooltool","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mozilla-releng/tooltool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla-releng%2Ftooltool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla-releng%2Ftooltool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla-releng%2Ftooltool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla-releng%2Ftooltool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mozilla-releng","download_url":"https://codeload.github.com/mozilla-releng/tooltool/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla-releng%2Ftooltool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29019464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T18:51:31.335Z","status":"ssl_error","status_checked_at":"2026-02-02T18:49:20.777Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["backend","frontend","openapi","python"],"created_at":"2026-02-02T20:53:32.397Z","updated_at":"2026-02-02T20:53:33.013Z","avatar_url":"https://github.com/mozilla-releng.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"ToolTool API, Frontend and Client\n\nBasics\n^^^^^^\n\nSome of the jobs in the releng infrastructure make use of generic binary artifacts, which are stored in dedicated artifacts repositories.\n\nTooltool is the client program, written in Python, which is used to retrieve these artifacts from the servers, and to perform integrity checks on them based on hashcode verification. Hence, the servers storing these artifacts are named \"tooltool servers\".\n\nA set of files to be fetched by tooltool is specified via a tooltool manifest, usually a file in JSON format with tt extension.\n\nThe following is an example of a valid tooltool manifest::\n\n    [\n    {\n    \"size\": 139308,\n    \"digest\": \"b2a463249bb3a9e7f2a3604697b000d2393db4f37b623fc099beb8456fbfdb332567013a3131ad138d8633cb19c50a8b77df3990d67500af896cada8b6f698b4\",\n    \"algorithm\": \"sha512\",\n    \"filename\": \"file2.pdf\"\n    },\n    {\n    \"size\": 3017536,\n    \"digest\": \"630d01a329c70aedb66ae7118d12ff7dc6fe06223d1c27b793e1bacc0ca84dd469ec1a6050184f8d9c35a0636546b0e2e5be08d9b51285e53eb1c9f959fef59d\",\n    \"algorithm\": \"sha512\",\n    \"filename\": \"file1.pdf\"\n    },\n    {\n    \"size\": 3420686,\n    \"digest\": \"931eb84f798dc9add1a10c7bbd4cc85fe08efda26cac473411638d1f856865524a517209d4c7184d838ee542c8ebc9909dc64ef60f8653a681270ce23524e8e4\",\n    \"algorithm\": \"sha512\",\n    \"filename\": \"file3.pdf\"\n    }\n    ]\n\nThe simplest usecase for tooltool is to run a \"fetch\" command to download the files mentioned in the manifest::\n\n    python tooltool.py fetch -m my-manifest.tt\n\nUploading to Tooltool\n^^^^^^^^^^^^^^^^^^^^^\n\nFirst, plan out your upload. Are all of the files you need to upload public? If not, tooltool also offers storage of \"internal\" files, which are not made publicly available but can be downloaded by those with proper permissions. Internal files might be under a non-redistribution license (e.g., Google SDKs, Microsoft DLLs), but must not include secrets such as passwords or private keys.\n\nUse the `tooltool.py` client to build a manifest containing the files you would like to upload, annotating each file with its visibility level::\n\n    python tooltool.py add --visibility public gcc.tar.gz\n\nNext, you will need credentials for the upload. Tooltool uses `Taskcluster`_ for authentication. To retrieve taskcluster credentials, run::\n\n    export TASKCLUSTER_ROOT_URL=https://firefox-ci-tc.services.mozilla.com/\n    taskcluster signin\n\n...and then put the clientId and accessToken you obtained into a JSON file as follows::\n\n    {\n        \"clientId\": \"xxxxxxxxxxxxx\",\n        \"accessToken\": \"xxxxxxxxxxxxxx\"\n    }\n\nNow, you're ready to upload with a command like::\n\n   python tooltool.py upload --authentication-file=~/.tooltool-token --message \"Bug 1234567: add new frobnicator binaries\"\n\n.. _`Taskcluster`: https://github.com/taskcluster/taskcluster/tree/main/clients/client-shell\n\nLocal Development\n^^^^^^^^^^^^^^^^^\n\nRun::\n\n    export TASKCLUSTER_ROOT_URL=https://firefox-ci-tc.services.mozilla.com/\n    # Use \"taskcluster signing\" if you don't have these\n    export TASKCLUSTER_CLIENT_ID=xxxxx\n    export TASKCLUSTER_ACCESS_TOKEN=xxxxx\n    # You will need to create your own bucket \u0026 AWS credentials\n    export S3_REGIONS=us-west-2:your-s3-bucket\n    export S3_REGIONS_ACCESS_KEY_ID=xxxxxx\n    export S3_REGIONS_SECRET_ACCESS_KEY=xxxxxx\n    docker-compose up\n\nTooltool should then be ready for use on https://localhost:8010.\n\nDeployment process\n^^^^^^^^^^^^^^^^^^\n\nTo trigger the deployment you have to push the code to the branch with the same\nname as environment you want to deploy to.\n\nThis will start Taskcluster graph which will build and push docker\nimage to docker hub (`mozilla/releng-tooltool`_) with the same tag as is the\nenvironment.\n\nCloudops team Jenkins is listening for the change and will deploy it to `GCP`_\nonce it confirms that the docker images was build in a trusted environment. It\nusually takes around 5min for deployment to be done. For more how things are \nconfigures you can check `cloudops infrastructure`_.:\n\nYou can check that the service was deployed correctly by visiting the\n``/__version__`` endpoint which should include the revision it was built from.\n\n.. _`GCP`: https://cloud.google.com\n.. _`mozilla/releng-tooltool`: https://hub.docker.com/r/mozilla/releng-tooltool\n.. _`cloudops infrastructure`: https://github.com/mozilla-services/cloudops-infra/tree/master/projects/relengapi/\n\n\nDeployed Environments\n^^^^^^^^^^^^^^^^^^^^^\n\nWe have a number of deployed ToolTool environments.\n\n- Staging\n\n   :URL: https://stage.tooltool.mozilla-releng.net/\n   :Deploys from: `staging` branch\n\n- Production\n\n   :URL: https://tooltool.mozilla-releng.net/\n   :Deploys from: `production` branch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla-releng%2Ftooltool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmozilla-releng%2Ftooltool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla-releng%2Ftooltool/lists"}