├── .github ├── ISSUE_TEMPLATE │ ├── feature.md │ └── bug.md └── workflows │ └── shellcheck.yml ├── README.md ├── ci └── shellcheck ├── DCO ├── CONTRIBUTING.md ├── code-of-conduct.md ├── rhcos-toolbox └── LICENSE /.github/ISSUE_TEMPLATE/feature.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an enhancement to toolbox 4 | --- 5 | 6 | # Feature Request # 7 | 8 | ## Environment ## 9 | 10 | What hardware/cloud provider/hypervisor is being used to run toolbox? 11 | 12 | ## Desired Feature ## 13 | 14 | ## Other Information ## 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # toolbox - bring your tools with you 2 | 3 | rhcos-toolbox is a small script, designed for RHEL CoreOS, that launches a 4 | podman container to let you bring in your favorite debugging or admin tools. 5 | 6 | This project is deprecated and in maintenance mode. 7 | 8 | We recommend that you use https://github.com/containers/toolbox instead. 9 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Report an issue with toolbox 4 | --- 5 | 6 | # Bug # 7 | 8 | ## Host Operating System Version ## 9 | 10 | ## Environment ## 11 | 12 | What hardware/cloud provider/hypervisor is being used to run toolbox? 13 | 14 | ## Expected Behavior ## 15 | 16 | ## Actual Behavior ## 17 | 18 | ## Reproduction Steps ## 19 | 20 | 1. ... 21 | 2. ... 22 | 23 | ## Other Information ## 24 | -------------------------------------------------------------------------------- /.github/workflows/shellcheck.yml: -------------------------------------------------------------------------------- 1 | # Template generated by https://github.com/coreos/repo-templates; do not edit downstream 2 | 3 | name: ShellCheck 4 | 5 | on: 6 | pull_request: 7 | branches: [main] 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | shellcheck: 14 | name: Shellcheck 15 | runs-on: ubuntu-latest 16 | container: quay.io/coreos-assembler/fcos-buildroot:testing-devel 17 | steps: 18 | - name: Check out repository 19 | uses: actions/checkout@v5 20 | # https://github.com/actions/checkout/issues/760 21 | - name: Mark git checkout as safe 22 | run: git config --global --add safe.directory "$GITHUB_WORKSPACE" 23 | - name: Run ShellCheck 24 | run: ci/shellcheck 25 | -------------------------------------------------------------------------------- /ci/shellcheck: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Template generated by https://github.com/coreos/repo-templates; do not edit downstream 3 | 4 | set -euo pipefail 5 | 6 | main() { 7 | local found_errors="false" 8 | # Let's start with error, then we can do warning, info, style 9 | local -r severity="error" 10 | 11 | while IFS= read -r -d '' f; do 12 | # Skip non-text files that are very unlikely to be shell scripts 13 | if [[ "$(file -b --mime-type "${f}" | sed 's|/.*||')" != "text" ]]; then 14 | continue 15 | fi 16 | shebang="$(head -1 "${f}")" 17 | if [[ "${f}" == *.sh ]] || \ 18 | [[ ${shebang} =~ ^#!/.*/bash.* ]] || \ 19 | [[ ${shebang} =~ ^#!/.*/env\ bash ]]; then 20 | echo "[+] Checking ${f}" 21 | shellcheck --external-sources --shell bash --severity="${severity}" "${f}" || found_errors="true" 22 | bash -n "${f}" || found_errors="true" 23 | fi 24 | done< <(find . -path "./.git" -prune -o -path "./vendor" -prune -o -type f -print0) 25 | 26 | if [[ "${found_errors}" != "false" ]]; then 27 | echo "[+] Found errors with ShellCheck" 28 | exit 1 29 | fi 30 | 31 | echo "[+] No error found with ShellCheck" 32 | exit 0 33 | } 34 | 35 | main "${@}" 36 | -------------------------------------------------------------------------------- /DCO: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 660 York Street, Suite 102, 6 | San Francisco, CA 94110 USA 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | 12 | Developer's Certificate of Origin 1.1 13 | 14 | By making a contribution to this project, I certify that: 15 | 16 | (a) The contribution was created in whole or in part by me and I 17 | have the right to submit it under the open source license 18 | indicated in the file; or 19 | 20 | (b) The contribution is based upon previous work that, to the best 21 | of my knowledge, is covered under an appropriate open source 22 | license and I have the right under that license to submit that 23 | work with modifications, whether created in whole or in part 24 | by me, under the same open source license (unless I am 25 | permitted to submit under a different license), as indicated 26 | in the file; or 27 | 28 | (c) The contribution was provided directly to me by some other 29 | person who certified (a), (b) or (c) and I have not modified 30 | it. 31 | 32 | (d) I understand and agree that this project and the contribution 33 | are public and that a record of the contribution (including all 34 | personal information I submit with it, including my sign-off) is 35 | maintained indefinitely and may be redistributed consistent with 36 | this project or the open source license(s) involved. 37 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via 4 | GitHub pull requests. This document outlines some of the conventions on 5 | development workflow, commit message formatting, contact points and other 6 | resources to make it easier to get your contribution accepted. 7 | 8 | # Certificate of Origin 9 | 10 | By contributing to this project you agree to the Developer Certificate of 11 | Origin (DCO). This document was created by the Linux Kernel community and is a 12 | simple statement that you, as a contributor, have the legal right to make the 13 | contribution. See the [DCO](DCO) file for details. 14 | 15 | ## Getting Started 16 | 17 | - Fork the repository on GitHub 18 | - Read the [README](README.md) for build and test instructions 19 | - Play with the project, submit bugs, submit patches! 20 | 21 | ## Contribution Flow 22 | 23 | This is a rough outline of what a contributor's workflow looks like: 24 | 25 | - Create a topic branch from where you want to base your work (usually main). 26 | - Make commits of logical units. 27 | - Make sure your commit messages are in the proper format (see below). 28 | - Push your changes to a topic branch in your fork of the repository. 29 | - Make sure the tests pass, and add any new tests as appropriate. 30 | - Submit a pull request to the original repository. 31 | 32 | Thanks for your contributions! 33 | 34 | ### Format of the Commit Message 35 | 36 | We follow a rough convention for commit messages borrowed from AngularJS. This 37 | is an example of a commit: 38 | 39 | ``` 40 | feat(scripts/test-cluster): add a cluster test command 41 | 42 | this uses tmux to setup a test cluster that you can easily kill and 43 | start for debugging. 44 | ``` 45 | 46 | The format can be described more formally as follows: 47 | 48 | ``` 49 | (): 50 | 51 | 52 | 53 |