{"id":19963668,"url":"https://github.com/cyberark/conjur-inspect","last_synced_at":"2025-10-26T00:47:29.569Z","repository":{"id":185411906,"uuid":"154524050","full_name":"cyberark/conjur-inspect","owner":"cyberark","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-31T19:11:25.000Z","size":261,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-03T22:36:36.372Z","etag":null,"topics":["hackathon","proof-of-concept"],"latest_commit_sha":null,"homepage":null,"language":"Go","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/cyberark.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-24T15:23:10.000Z","updated_at":"2025-03-12T10:23:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"55a6fc52-a8b6-4bb1-bd83-356bde42f3f7","html_url":"https://github.com/cyberark/conjur-inspect","commit_stats":null,"previous_names":["cyberark/conjur-inspect"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/cyberark/conjur-inspect","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fconjur-inspect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fconjur-inspect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fconjur-inspect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fconjur-inspect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberark","download_url":"https://codeload.github.com/cyberark/conjur-inspect/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fconjur-inspect/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281043417,"owners_count":26434444,"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","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["hackathon","proof-of-concept"],"created_at":"2024-11-13T02:16:44.938Z","updated_at":"2025-10-26T00:47:29.527Z","avatar_url":"https://github.com/cyberark.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Conjur Inspect\n\nConjur Inspect is a command-line tool that validates a system for running\nConjur Enterprise successfully and gathers system information for\ntroubleshooting when Conjur Enterprise isn't running correctly.\n\n## Certification level\n\n![](https://img.shields.io/badge/Certification%20Level-Trusted-28A745?link=https://github.com/cyberark/community/blob/master/Conjur/conventions/certification-levels.md)\n\nThis repo is a **Trusted** level project. It is supported by CyberArk and has\nbeen verified to work with Conjur Enterprise. For more detailed information on\nour certification levels, see\n[our community guidelines](https://github.com/cyberark/community/blob/master/Conjur/conventions/certification-levels.md#trusted).\n\n## Getting Started\n\n### Obtaining install package\n\nThe latest Conjur Inspect install package may either be downloaded from\n[Releases](https://github.com/cyberark/conjur-inspect/releases) or copied\nfrom a Conjur Enterprise Appliance container image (version 13.5 or later)\nwith the following commands:\n\n1. First, create a container instance using the Conjur Enterprise Appliance\n   image. This doesn't need to be a configured Conjur instance, only a running\n   container using the image:\n\n   ```sh\n   docker run -d --name conjur registry.tld/conjur-appliance:\u003cversion\u003e\n   ```\n\n2. List the available Conjur Inspect install packages with the command:\n\n   ```sh\n   docker exec -it conjur ls -la /opt/conjur/conjur-inspect\n   ```\n\n   This will output a file listing similar to:\n\n   ```sh\n   -rw-r--r-- 1 root   root   32989 Oct 22 14:19 conjur-inspect_0.4.0_linux_386.tar.gz\n   -rw-r--r-- 1 root   root   32991 Oct 22 14:19 conjur-inspect_0.4.0_linux_amd64.tar.gz\n   -rw-r--r-- 1 root   root   32991 Oct 22 14:19 conjur-inspect_0.4.0_linux_arm64.tar.gz\n   ```\n\n3. Select the correct file based on your host system architecture and copy it\n   to the host with the command:\n\n   ```sh\n   docker cp conjur:/opt/conjur/conjur-inspect/conjur-inspect_0.4.0_linux_amd64.tar.gz .\n   ```\n\n4. Remove the temporary Conjur container with the command:\n\n   ```sh\n   docker rm -f conjur\n   ```\n\n### Installing\n\nTo install Conjur Inspect, copy the install package for your system\narchitecture to your target host machine. This is the machine or VM where the\nConjur Enterprise container will run.\n\nExtract the tool from the gzip archive:\n\n```sh-session\n$ tar -xvf conjur-inspect-0.4.0_amd64.tgz\n```\n\nOr install it from one of the system packages:\n\n```sh\nyum install conjur-inspect_0.4.0_amd64.rpm\n```\n\n```sh\napt install conjur-inspect_0.4.0_386.deb\n```\n\n### Running\n\nRun Conjur Inspect with the following command as the same system user that will\nrun the Conjur container:\n\n```sh-session\n$ conjur-inspect\n```\n\nThis command generates an inspection report of different system indicators\nrelated to Conjur stability performance:\n\n```sh\n========================================\nConjur Enterprise Inspection Report\nVersion: 0.3.0-ef572db (Build 46)\n========================================\n\nCPU\n---\nINFO - CPU Cores: 4\nINFO - CPU Architecture: amd64\n\nDisk\n----\nINFO - Disk Space (tmpfs, /dev): 8.1 GB Total, 0 B Used ( 0%), 8.1 GB Free\n...\n\nMemory\n------\nINFO - Memory Total: 16 GB\nINFO - Memory Free: 15 GB\nINFO - Memory Used: 813 MB (5.0 %)\n\nHost\n----\nINFO - Hostname: ip-172-31-17-12.ec2.internal\nINFO - Uptime: 8 minutes 35 seconds\nINFO - OS: linux, redhat, rhel, 8.6\nINFO - Virtualization: None\n\nFollower\n--------\nERROR - Leader Hostname: N/A (Leader hostname is not set. Set the 'MASTER_HOSTNAME' environment variable to run this check)\n\nContainer Runtime\n-----------------\nERROR - Docker: N/A (failed to inspect Docker runtime: exec: \"docker\": executable file not found in $PATH ())\nINFO - Podman Version: 4.2.0\nINFO - Podman Driver: overlay\nINFO - Podman Graph Root: /home/ec2-user/.local/share/containers/storage\nINFO - Podman Run Root: /run/user/1000/containers\nINFO - Podman Volume Path: /home/ec2-user/.local/share/containers/storage/volumes\n\nUlimits\n-------\nINFO - core file size (blocks, -c): 0\n...\n```\n\nAvailable options and flags may be view by running:\n\n```sh\nconjur-inspect --help\n```\n\n## Gathering container specific inspection data\n\nTo gather inspection data for a Conjur Enterprise container that is already\nrunning, include the `--container-id` argument with either the container name\nor ID. For example:\n\n```sh\nconjur-inspect --container-id conjur\n```\n\n## Raw data report\n\nIn addition to the output report, `conjur-inspect` records the raw inspection\ndata in a gzipped archived saved as a filed to the working directory. By default,\nthis archived is named with the timestamp when `conjur-inspect` was\nrun. For example, `2023-05-26-15-51.tar.gz`.\n\nThe name of the output archive may be customized with the `--report-id` argument.\nFor example:\n\n```sh\nconjur-inspect --report-id standby\n```\n\nThis results in an output archived named `standby.tar.gz`.\n\n## Inspecting disk performance\n\nThe Conjur Inspect disk performance checks require an additional dependency,\n`fio`, to be installed as a prerequisite. This may be installed from OS package\nmanagement tools. For example:\n\n```sh\nyum install fio\n```\n\nor\n\n```sh\napt install fio\n```\n\nWhen `fio` is installed, `conjur-inspect` reports additional information about\ndisk latency and throughput:\n\n```sh-session\n./conjur-inspect\n========================================\nConjur Enterprise Inspection Report\nVersion: 0.3.0-ef572db (Build 46)\n========================================\n\n...\n\nDisk\n----\n...\nINFO - FIO - Read IOPs (/home/ec2-user/conjur-inspect_0.3.0_linux_amd64): 1624.33 (Min: 874, Max: 3902, StdDev: 221.16)\nINFO - FIO - Write IOPs (/home/ec2-user/conjur-inspect_0.3.0_linux_amd64): 1674.32 (Min: 884, Max: 4018, StdDev: 228.43)\nINFO - FIO - Read Latency (99%, /home/ec2-user/conjur-inspect_0.3.0_linux_amd64): 0.00 ms\nINFO - FIO - Write Latency (99%, /home/ec2-user/conjur-inspect_0.3.0_linux_amd64): 0.00 ms\nINFO - FIO - Sync Latency (99%, /home/ec2-user/conjur-inspect_0.3.0_linux_amd64): 1.48 ms\n\n...\n```\n\n## Troubleshooting\n\nTo troubleshoot issues running `conjur-inspect`, add the `--debug` flag for\ndetailed execution output.\n\n## Community Support\n\nOur primary channel for support is through our CyberArk Commons community\n[here](https://discuss.cyberarkcommons.org/c/conjur/5).\n\n## Code Maintainers\n\nCyberArk Conjur Team\n\n## Contributing\n\nFor information on how to contribute to this project, see [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## License\n\nCopyright (c) 2023 CyberArk Software Ltd. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis software except in compliance with the License. You may obtain a copy of\nthe License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n\nFor the full license text see [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fconjur-inspect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberark%2Fconjur-inspect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fconjur-inspect/lists"}