├── .github ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── pull_request_template.md └── workflows │ ├── ah_token_refresh.yml │ ├── ansible-lint.yml │ ├── ansible-test.yml │ ├── extra-docs-linting.yml │ └── release.yml ├── .gitignore ├── .vscode └── extensions.json ├── CHANGELOG.rst ├── CONTRIBUTING.md ├── LICENSE ├── MAINTAINERS ├── MAINTAINING.md ├── README.md ├── REVIEW_CHECKLIST.md ├── build_context ├── Containerfile └── _build │ └── requirements.yml ├── changelogs ├── changelog.yaml ├── config.yaml └── fragments │ ├── .keep │ ├── 63-add-default-skip-lvms-in-kickstart-post.yaml │ └── 64-fix-kickstart-post-to-match-convention.yaml ├── codecov.yml ├── execution-environment.yml ├── galaxy.yml ├── meta └── runtime.yml ├── playbooks ├── microshift_app.yml ├── microshift_image_build.yml └── microshift_rpm_install.yml ├── requirements.yml ├── roles ├── app │ ├── README.md │ ├── defaults │ │ └── main.yml │ ├── handlers │ │ └── main.yml │ ├── meta │ │ └── main.yml │ ├── tasks │ │ └── main.yml │ ├── tests │ │ ├── inventory │ │ └── test.yml │ └── vars │ │ └── main.yml ├── image_builder │ ├── README.md │ ├── defaults │ │ └── main.yml │ ├── handlers │ │ └── main.yml │ ├── meta │ │ └── main.yml │ ├── tasks │ │ └── main.yml │ ├── templates │ │ ├── crio_proxy.j2 │ │ ├── firewall_options.j2 │ │ ├── lvms_setup.j2 │ │ ├── ovn_options.j2 │ │ └── pull_secret.j2 │ ├── tests │ │ ├── inventory │ │ └── test.yml │ └── vars │ │ └── main.yml └── rpm_install │ ├── README.md │ ├── defaults │ └── main.yml │ ├── handlers │ └── main.yml │ ├── meta │ └── main.yml │ ├── tasks │ └── main.yml │ ├── tests │ ├── inventory │ └── test.yml │ └── vars │ └── main.yml └── tests ├── integration └── targets │ └── .gitkeep └── units └── .gitkeep /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @maxamillion @thom-at-redhat @de1987 @resoluteCoder @matoval 2 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Community Code of Conduct 2 | 3 | Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html). 4 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | 8 | 9 | FIXES: 10 | 11 | ## Type of change 12 | 13 | What is it? 14 | 15 | - [ ] Bug fix (non-breaking change which fixes an issue) 16 | - [ ] New feature (non-breaking change which adds functionality) 17 | - [ ] Documentation update 18 | - [ ] Tests update 19 | - [ ] Refactor 20 | 21 | ## Checklist 22 | 23 | - [ ] Added changelog fragment 24 | - [ ] Tests exist for affected features covering positive and negative scenarios -------------------------------------------------------------------------------- /.github/workflows/ah_token_refresh.yml: -------------------------------------------------------------------------------- 1 | name: Refresh the automation hub token 2 | on: # yamllint disable-line rule:truthy 3 | schedule: 4 | - cron: '0 0 * * *' 5 | workflow_dispatch: 6 | 7 | jobs: 8 | refresh: 9 | uses: ansible/devtools/.github/workflows/ah_token_refresh.yml@main 10 | with: 11 | environment: release 12 | secrets: 13 | ah_token: ${{ secrets.AH_TOKEN }} 14 | -------------------------------------------------------------------------------- /.github/workflows/ansible-lint.yml: -------------------------------------------------------------------------------- 1 | --- 2 | on: # yamllint disable-line rule:truthy 3 | pull_request: 4 | branches: 5 | - main 6 | push: 7 | branches: 8 | - main 9 | jobs: 10 | lint: 11 | name: Ansible Lint 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | 16 | - name: Install ansible-lint 17 | run: pip install ansible-lint 18 | 19 | - name: Run ansible-lint 20 | run: ansible-lint --profile=production 21 | -------------------------------------------------------------------------------- /.github/workflows/ansible-test.yml: -------------------------------------------------------------------------------- 1 | # README FIRST 2 | # 1. If you don't have unit tests, remove that section. 3 | # 2. If your collection depends on other collections ensure they are installed, 4 | # add them to the "test-deps" input. 5 | # 3. For the comprehensive list of the inputs supported by the 6 | # ansible-community/ansible-test-gh-action GitHub Action, see 7 | # https://github.com/marketplace/actions/ansible-test. 8 | # 4. If you want to prevent merging PRs that do not pass all tests, 9 | # make sure to add the "check" job to your repository branch 10 | # protection once this workflow is added. 11 | # It is also possible to tweak which jobs are allowed to fail. See 12 | # https://github.com/marketplace/actions/alls-green#gotchas for more detail. 13 | # 5. If you need help please join us at https://forum.ansible.com. 14 | 15 | name: CI 16 | on: # yamllint disable-line rule:truthy 17 | # Run CI for stable and pre-release publish 18 | release: 19 | types: [published] 20 | # Run CI against all pushes (direct commits, also merged PRs), Pull Requests 21 | push: 22 | branches: 23 | - main 24 | - stable-* 25 | pull_request: 26 | # Run CI once per day (at 06:00 UTC) 27 | # This ensures that even if there haven't been commits that we are still 28 | # testing against latest version of ansible-test for each ansible-core 29 | # version 30 | schedule: 31 | - cron: '0 6 * * *' 32 | 33 | concurrency: 34 | group: >- 35 | ${{ github.workflow }}-${{ 36 | github.event.pull_request.number || github.sha 37 | }} 38 | cancel-in-progress: true 39 | 40 | jobs: 41 | 42 | ### 43 | # Sanity tests (REQUIRED) 44 | # 45 | # https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html 46 | 47 | sanity: 48 | name: Sanity (Ⓐ${{ matrix.ansible }}) 49 | strategy: 50 | matrix: 51 | ansible: 52 | # It's important that Sanity is tested against all stable-X.Y branches 53 | # Testing against `devel` may fail as new tests are added. 54 | # An alternative to `devel` is the `milestone` branch with 55 | # gets synchronized with `devel` every few weeks and therefore 56 | # tends to be a more stable target. Be aware that it is not updated 57 | # around creation of a new stable branch, this might cause a problem 58 | # that two different versions of ansible-test use the same sanity test 59 | # ignore.txt file. 60 | # The commented branches below are EOL, 61 | # do you really need your collection to support them if it still does? 62 | # - stable-2.9 # Only if your collection supports Ansible 2.9 63 | # - stable-2.10 # Only if your collection supports ansible-base 2.10 64 | # - stable-2.11 # Only if your collection supports ansible-core 2.11 65 | - stable-2.12 66 | - stable-2.13 67 | - stable-2.14 68 | - devel 69 | # - milestone 70 | # Ansible-test on various stable branches does not yet work well with cgroups v2. 71 | # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04 72 | # image for these stable branches. The list of branches where this is necessary will 73 | # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28 74 | # for the latest list. 75 | runs-on: >- 76 | ${{ contains(fromJson( 77 | '["stable-2.9", "stable-2.10", "stable-2.11"]' 78 | ), matrix.ansible) && 'ubuntu-20.04' || 'ubuntu-latest' }} 79 | steps: 80 | # Run sanity tests inside a Docker container. 81 | # The docker container has all the pinned dependencies that are 82 | # required and all Python versions Ansible supports. 83 | - name: Perform sanity testing 84 | # See the documentation for the following GitHub action on 85 | # https://github.com/ansible-community/ansible-test-gh-action/blob/main/README.md 86 | uses: ansible-community/ansible-test-gh-action@release/v1 87 | with: 88 | ansible-core-version: ${{ matrix.ansible }} 89 | testing-type: sanity 90 | # OPTIONAL If your sanity tests require code 91 | # from other collections, install them like this 92 | # test-deps: >- 93 | # ansible.netcommon 94 | # ansible.utils 95 | # OPTIONAL If set to true, will test only against changed files, 96 | # which should improve CI performance. See limitations on 97 | # https://github.com/ansible-community/ansible-test-gh-action#pull-request-change-detection 98 | pull-request-change-detection: true 99 | 100 | ### 101 | # Unit tests (OPTIONAL) 102 | # 103 | # https://docs.ansible.com/ansible/latest/dev_guide/testing_units.html 104 | 105 | units: 106 | # Ansible-test on various stable branches does not yet work well with cgroups v2. 107 | # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04 108 | # image for these stable branches. The list of branches where this is necessary will 109 | # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28 110 | # for the latest list. 111 | runs-on: >- 112 | ${{ contains(fromJson( 113 | '["stable-2.9", "stable-2.10", "stable-2.11"]' 114 | ), matrix.ansible) && 'ubuntu-20.04' || 'ubuntu-latest' }} 115 | name: Units (Ⓐ${{ matrix.ansible }}) 116 | strategy: 117 | # As soon as the first unit test fails, cancel the others to free up the CI queue 118 | fail-fast: true 119 | matrix: 120 | ansible: 121 | # The commented branches below are EOL, 122 | # do you really need your collection to support them if it still does? 123 | # - stable-2.9 # Only if your collection supports Ansible 2.9 124 | # - stable-2.10 # Only if your collection supports ansible-base 2.10 125 | # - stable-2.11 # Only if your collection supports ansible-core 2.11 126 | - stable-2.12 127 | - stable-2.13 128 | - stable-2.14 129 | - devel 130 | # - milestone 131 | 132 | steps: 133 | - name: >- 134 | Perform unit testing against 135 | Ansible version ${{ matrix.ansible }} 136 | # See the documentation for the following GitHub action on 137 | # https://github.com/ansible-community/ansible-test-gh-action/blob/main/README.md 138 | uses: ansible-community/ansible-test-gh-action@release/v1 139 | with: 140 | ansible-core-version: ${{ matrix.ansible }} 141 | testing-type: units 142 | # OPTIONAL If your unit tests require code 143 | # from other collections, install them like this 144 | test-deps: >- 145 | ansible.netcommon 146 | ansible.utils 147 | # OPTIONAL If set to true, will test only against changed files, 148 | # which should improve CI performance. See limitations on 149 | # https://github.com/ansible-community/ansible-test-gh-action#pull-request-change-detection 150 | pull-request-change-detection: true 151 | 152 | ### 153 | # Integration tests (RECOMMENDED) 154 | # 155 | # https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html 156 | 157 | 158 | # If the application you are testing is available as a docker container and you want to test 159 | # multiple versions see the following for an example: 160 | # https://github.com/ansible-collections/community.zabbix/tree/master/.github/workflows 161 | 162 | integration: 163 | # Ansible-test on various stable branches does not yet work well with cgroups v2. 164 | # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04 165 | # image for these stable branches. The list of branches where this is necessary will 166 | # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28 167 | # for the latest list. 168 | runs-on: >- 169 | ${{ contains(fromJson( 170 | '["stable-2.9", "stable-2.10", "stable-2.11"]' 171 | ), matrix.ansible) && 'ubuntu-20.04' || 'ubuntu-latest' }} 172 | name: I (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }}) 173 | strategy: 174 | fail-fast: false 175 | matrix: 176 | ansible: 177 | # The commented branches below are EOL, 178 | # do you really need your collection to support them if it still does? 179 | # - stable-2.9 # Only if your collection supports Ansible 2.9 180 | # - stable-2.10 # Only if your collection supports ansible-base 2.10 181 | # - stable-2.11 # Only if your collection supports ansible-core 2.11 182 | - stable-2.12 183 | - stable-2.13 184 | - stable-2.14 185 | - devel 186 | # - milestone 187 | python: 188 | - '3.5' 189 | - '3.6' 190 | - '3.7' 191 | - '3.8' 192 | - '3.9' 193 | - '3.10' 194 | - '3.11' 195 | exclude: 196 | # Because ansible-test doesn't support Python 3.9 for Ansible 2.9 197 | # and Python 3.10 is supported in 2.12 or later. 198 | - ansible: devel 199 | python: '3.5' 200 | - ansible: stable-2.9 201 | python: '3.9' 202 | - ansible: stable-2.9 203 | python: '3.10' 204 | - ansible: stable-2.10 205 | python: '3.10' 206 | - ansible: stable-2.11 207 | python: '3.10' 208 | - ansible: stable-2.12 209 | python: '3.11' 210 | - ansible: stable-2.13 211 | python: '3.11' 212 | 213 | steps: 214 | - name: >- 215 | Perform integration testing against 216 | Ansible version ${{ matrix.ansible }} 217 | under Python ${{ matrix.python }} 218 | # See the documentation for the following GitHub action on 219 | # https://github.com/ansible-community/ansible-test-gh-action/blob/main/README.md 220 | uses: ansible-community/ansible-test-gh-action@release/v1 221 | with: 222 | ansible-core-version: ${{ matrix.ansible }} 223 | # OPTIONAL command to run before invoking `ansible-test integration` 224 | # pre-test-cmd: 225 | target-python-version: ${{ matrix.python }} 226 | testing-type: integration 227 | # OPTIONAL If your integration tests require code 228 | # from other collections, install them like this 229 | test-deps: ansible.netcommon 230 | # OPTIONAL If set to true, will test only against changed files, 231 | # which should improve CI performance. See limitations on 232 | # https://github.com/ansible-community/ansible-test-gh-action#pull-request-change-detection 233 | pull-request-change-detection: true 234 | 235 | 236 | check: # This job does nothing and is only used for the branch protection 237 | # or multi-stage CI jobs, like making sure that all tests pass before 238 | # a publishing job is started. 239 | if: always() 240 | 241 | needs: 242 | - sanity 243 | - units 244 | - integration 245 | 246 | runs-on: ubuntu-latest 247 | 248 | steps: 249 | - name: Decide whether the needed jobs succeeded or failed 250 | uses: re-actors/alls-green@release/v1 251 | with: 252 | jobs: ${{ toJSON(needs) }} 253 | -------------------------------------------------------------------------------- /.github/workflows/extra-docs-linting.yml: -------------------------------------------------------------------------------- 1 | name: Lint extra docsite docs and links 2 | on: # yamllint disable-line rule:truthy 3 | # Run CI against all pushes (direct commits, also merged PRs), Pull Requests 4 | push: 5 | branches: 6 | - main 7 | - stable-* 8 | pull_request: 9 | # Run CI once per day (at 06:00 UTC) 10 | # This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version 11 | schedule: 12 | - cron: '0 6 * * *' 13 | 14 | jobs: 15 | docsite: 16 | name: Lint extra docsite docs and links 17 | permissions: 18 | contents: read 19 | runs-on: ubuntu-latest 20 | steps: 21 | 22 | - name: Check out code 23 | uses: actions/checkout@v3 24 | 25 | - name: Set up Python 26 | uses: actions/setup-python@v3 27 | with: 28 | python-version: '3.10' 29 | 30 | - name: Install antsibull-docs 31 | run: pip install antsibull-docs --disable-pip-version-check 32 | 33 | - name: Run collection docs linter 34 | run: antsibull-docs lint-collection-docs . 35 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Release the ansible collection 3 | on: # yamllint disable-line rule:truthy 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | release: 9 | uses: ansible/devtools/.github/workflows/release_collection.yml@main 10 | with: 11 | environment: release 12 | galaxy_publish: false 13 | secrets: 14 | ah_token: ${{ secrets.AH_TOKEN }} 15 | ansible_galaxy_api_key: ${{ secrets.ANSIBLE_GALAXY_API_KEY }} 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /tests/output/ 2 | /changelogs/.plugin-cache.yaml 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | pip-wheel-metadata/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | 57 | # Translations 58 | *.mo 59 | *.pot 60 | 61 | # Django stuff: 62 | *.log 63 | local_settings.py 64 | db.sqlite3 65 | db.sqlite3-journal 66 | 67 | # Flask stuff: 68 | instance/ 69 | .webassets-cache 70 | 71 | # Scrapy stuff: 72 | .scrapy 73 | 74 | # Sphinx documentation 75 | docs/_build/ 76 | 77 | # PyBuilder 78 | target/ 79 | 80 | # Jupyter Notebook 81 | .ipynb_checkpoints 82 | 83 | # IPython 84 | profile_default/ 85 | ipython_config.py 86 | 87 | # pyenv 88 | .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 98 | __pypackages__/ 99 | 100 | # Celery stuff 101 | celerybeat-schedule 102 | celerybeat.pid 103 | 104 | # SageMath parsed files 105 | *.sage.py 106 | 107 | # Environments 108 | .env 109 | .venv 110 | env/ 111 | venv/ 112 | ENV/ 113 | env.bak/ 114 | venv.bak/ 115 | 116 | # Spyder project settings 117 | .spyderproject 118 | .spyproject 119 | 120 | # Rope project settings 121 | .ropeproject 122 | 123 | # mkdocs documentation 124 | /site 125 | 126 | # mypy 127 | .mypy_cache/ 128 | .dmypy.json 129 | dmypy.json 130 | 131 | # Pyre type checker 132 | .pyre/ 133 | 134 | # inventory 135 | *.ini 136 | 137 | # VSCode settings file 138 | /.vscode/settings.json 139 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "redhat.ansible" 4 | ] 5 | } 6 | -------------------------------------------------------------------------------- /CHANGELOG.rst: -------------------------------------------------------------------------------- 1 | ==================================================== 2 | CHANGE THIS IN changelogs/config.yaml! Release Notes 3 | ==================================================== 4 | 5 | .. contents:: Topics 6 | 7 | 8 | v1.0.3 9 | ====== 10 | 11 | Minor Changes 12 | ------------- 13 | 14 | - Fix builder_compose_pkgs bug, update Microshift to 4.13 15 | 16 | v1.0.1 17 | ====== 18 | 19 | Minor Changes 20 | ------------- 21 | 22 | - Replace system roles with community.general 23 | - Update OSBuild dependency from git to Galaxy 24 | 25 | v1.0.0 26 | ====== 27 | 28 | Major Changes 29 | ------------- 30 | 31 | - image_builder - Added ability to configure ovs-kubernetes and crio proxy 32 | - image_builder - add rhsm repo support 33 | - image_builder - added ability to provide pull secrets to kickstart 34 | - image_builder - added app role to deploy manifests onto microshift system 35 | - image_builder - added default firewall option for mandatory microshift rules and ability to create additional port/sources for zones 36 | - image_builder - added rpm_install role to automate the install for microshift on rpm based systems 37 | - image_builder - added storage config to kickstart file 38 | - image_builder - created new image builder role to create image with microshift and necessary bits baked in 39 | 40 | Minor Changes 41 | ------------- 42 | 43 | - image_builder - add playbook to deploy demo app to microshift 44 | - image_builder - add rhsm repo var for rhocp & fast_datapath_for_rhel 45 | - image_builder - content readme updated 46 | - image_builder - create set_fact loop to set fact in a DRY way 47 | - image_builder - relocate rhsm_repos_info management to infra.osbuild 48 | - image_builder - used latest version for osbuild 49 | - image_builder - uses the new updated way of adding kickstart post to osbuild additional_kickstart_post var 50 | - microshift_e2e_test - add microshift test playbook 51 | 52 | Bugfixes 53 | -------- 54 | 55 | - image_builder - change compose_type to builder_compose_type to pass the value to osbuild builder role 56 | - image_builder - fix issue where iso fails to auto install 57 | - image_builder - pass sshkey instead of the file path 58 | - image_builder - update lvms namespace to match the collections namespace 59 | - image_builder - updated microshift_kickstart_post variable to fix issue with omit in kickstart post 60 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Refer to the [Contributing guidelines](https://github.com/ansible/community-docs/blob/main/contributing.rst). 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MAINTAINERS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-cop/edge.microshift/6fe93848e3dcfc30a42967478830c3e4251c4b9b/MAINTAINERS -------------------------------------------------------------------------------- /MAINTAINING.md: -------------------------------------------------------------------------------- 1 | # Maintaining this collection 2 | 3 | Refer to the [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst). 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Microshift management and automation Collection 2 | 3 | [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7481/badge)](https://bestpractices.coreinfrastructure.org/projects/7481) 4 | 5 | [Ansible Collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) 6 | for management and automation of [microshift](https://microshift.io/) 7 | to build [rpm-ostree](https://rpm-ostree.readthedocs.io/en/latest/) based images to run microshift, 8 | configure microshift, upgrade microshift, deploy [kubernetes](https://kubernetes.io/) workloads on 9 | microshift, and much more. 10 | 11 | ## Installing 12 | 13 | To install this collection and its dependencies, you will need to use the [Ansible](https://github.com/ansible/ansible) `ansible-galaxy` command: 14 | 15 | ```shell 16 | ansible-galaxy collection install edge.microshift 17 | ``` 18 | 19 | ## Development Environment 20 | 21 | To use this while developing, run the following commands from within your local directory you pulled to this git repo to in order to symlink this git repo to the appropriate [Ansible Collection path](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths). 22 | 23 | ```shell 24 | mkdir -p ~/.ansible/collections/ansible_collections/edge 25 | ln -s $(pwd) ~/.ansible/collections/ansible_collections/edge/microshift 26 | ``` 27 | 28 | ## How to use 29 | 30 | You will need a RHEL 9.2 system 31 | 32 | ### RPM based install 33 | 34 | The RHEL 9.2 system will act as the microshift node. 35 | Run the example playbook to install latest V4.13 microshift on the RHEL system. 36 | The example uses inventory group `all`, so be sure to setup your ansible inventory correctly. 37 | 38 | ```bash 39 | ansible-playbook playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.* 40 | ``` 41 | 42 | If you just want to try out on the local host, use 43 | 44 | ```bash 45 | ansible-playbook -i localhost, playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.* 46 | ``` 47 | 48 | This requires the current user to ssh into localhost. 49 | 50 | ### RPM-Ostree based install 51 | 52 | The RHEL 9.2 system will act as the image build server to create the Microshift image. 53 | Run the playbook to create an image with the microshift package and configurations on the RHEL system: 54 | 55 | ```bash 56 | ansible-playbook playbook/microshift_image_build.yml 57 | ``` 58 | 59 | ### Deploy application 60 | 61 | To deploy an application on a running microshift system refer to the app role [README](https://github.com/redhat-cop/edge.microshift/blob/main/roles/app/README.md) 62 | 63 | ## Communication 64 | 65 | 66 | 67 | Join the Ansible forum to ask questions, get help, and interact with us. 68 | 69 | - [Get Help](https://forum.ansible.com/c/help/6): get help or help others. 70 | Please add appropriate tags if you start new discussions; for example, 71 | use the [`edge`](https://forum.ansible.com/tags/c/help/6/none/edge) tag. 72 | - [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with 73 | fellow enthusiasts. 74 | - [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide 75 | announcements including social events. 76 | 77 | We announce releases and important changes through Ansible's [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). 78 | 79 | We also take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. 80 | 81 | For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). 82 | 83 | ## Governance 84 | 85 | 86 | 87 | The process of decision making in this collection is based on discussing and finding consensus among participants. 88 | 89 | Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it! 90 | 91 | ## Supported Versions of Ansible 92 | 93 | 94 | 95 | ## Ansible version compatibility 96 | 97 | This collection has been tested against following Ansible versions: **>=2.12**. 98 | 99 | Plugins and modules within a collection may be tested with only specific 100 | Ansible versions. A collection may contain metadata that identifies these versions. 101 | PEP440 is the schema used to describe the versions of Ansible. 102 | 103 | 104 | 105 | ## Tested with Ansible 106 | 107 | 108 | 109 | - ansible-core (devel) 110 | - ansible-core 2.14 (stable) 111 | - ansible-core 2.13 (stable) 112 | - ansible-core 2.12 (stable) 113 | 114 | ## Included content 115 | 116 | 117 | Roles: 118 | 119 | - image_builder 120 | - app 121 | - rpm_install 122 | 123 | ## Using this collection 124 | 125 | 126 | 127 | ### Installing the Collection from Ansible Galaxy 128 | 129 | > NOTE: This collection is not yet in Ansible Galaxy as it is under heavy development and has not been released 130 | 131 | Before using this collection, you need to install it with the Ansible Galaxy command-line tool: 132 | 133 | ```bash 134 | ansible-galaxy collection install edge.microshift 135 | ``` 136 | 137 | You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format: 138 | 139 | ```yaml 140 | --- 141 | collections: 142 | - name: edge.microshift 143 | ``` 144 | 145 | Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the `ansible` package. To upgrade the collection to the latest available version, run the following command: 146 | 147 | ```bash 148 | ansible-galaxy collection install edge.microshift --upgrade 149 | ``` 150 | 151 | You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version `0.1.0`: 152 | 153 | ```bash 154 | ansible-galaxy collection install edge.microshift:==0.1.0 155 | ``` 156 | 157 | See [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details. 158 | 159 | ## Code of Conduct 160 | 161 | We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project. 162 | 163 | If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint. 164 | 165 | ## Contributing to this collection 166 | 167 | 168 | 169 | The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software. 170 | 171 | We are actively accepting new contributors. 172 | 173 | Any kind of contribution is very welcome. 174 | 175 | You don't know how to start? Refer to our [contribution guide](https://docs.ansible.com/ansible/devel/community/contributor_path.html)! 176 | 177 | We use the following guidelines: 178 | 179 | - [CONTRIBUTING](https://docs.ansible.com/ansible/devel/community/contributor_path.html#making-your-first-contribution) 180 | - [REVIEW_CHECKLIST](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html) 181 | - [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) 182 | - [Ansible Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) 183 | - [Ansible Collection Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) 184 | 185 | ## Collection maintenance 186 | 187 | The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. If you have questions or need help, feel free to mention them in the proposals. 188 | 189 | To learn how to maintain / become a maintainer of this collection, refer to the [Maintainer guidelines](https://docs.ansible.com/ansible/devel/community/maintainers.html). 190 | 191 | See [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details. 192 | 193 | ## Release notes 194 | 195 | See the [changelog](https://github.com/redhat-cop/edge.microshift/blob/main/CHANGELOG.rst). 196 | 197 | ## More information 198 | 199 | - [Ansible Collection overview](https://github.com/ansible-collections/overview) 200 | - [Ansible User guide](https://docs.ansible.com/ansible/devel/user_guide/index.html) 201 | - [Ansible Developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) 202 | - [Ansible Collections Checklist](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst) 203 | - [Ansible Community code of conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) 204 | - [News for Maintainers](https://forum.ansible.com/tag/news-for-maintainers) 205 | 206 | ## Licensing 207 | 208 | 209 | 210 | GNU General Public License v3.0 or later. 211 | 212 | See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. 213 | -------------------------------------------------------------------------------- /REVIEW_CHECKLIST.md: -------------------------------------------------------------------------------- 1 | # Review Checklist 2 | 3 | Refer to the [Collection review checklist](https://github.com/ansible/community-docs/blob/main/review_checklist.rst). 4 | -------------------------------------------------------------------------------- /build_context/Containerfile: -------------------------------------------------------------------------------- 1 | ARG EE_BASE_IMAGE="quay.io/ansible/ansible-runner:latest" 2 | ARG EE_BUILDER_IMAGE="quay.io/ansible/ansible-builder:latest" 3 | ARG PYCMD="/usr/bin/python3" 4 | ARG PKGMGR_PRESERVE_CACHE="" 5 | ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS="" 6 | ARG ANSIBLE_GALAXY_CLI_ROLE_OPTS="" 7 | 8 | # Base build stage 9 | FROM $EE_BASE_IMAGE as base 10 | USER root 11 | ARG EE_BASE_IMAGE 12 | ARG EE_BUILDER_IMAGE 13 | ARG PYCMD 14 | ARG PKGMGR_PRESERVE_CACHE 15 | ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS 16 | ARG ANSIBLE_GALAXY_CLI_ROLE_OPTS 17 | 18 | RUN $PYCMD -m ensurepip 19 | COPY _build/scripts/ /output/scripts/ 20 | COPY _build/scripts/entrypoint /opt/builder/bin/entrypoint 21 | 22 | # Galaxy build stage 23 | FROM base as galaxy 24 | ARG EE_BASE_IMAGE 25 | ARG EE_BUILDER_IMAGE 26 | ARG PYCMD 27 | ARG PKGMGR_PRESERVE_CACHE 28 | ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS 29 | ARG ANSIBLE_GALAXY_CLI_ROLE_OPTS 30 | 31 | RUN /output/scripts/check_galaxy 32 | COPY _build /build 33 | WORKDIR /build 34 | 35 | RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS -r requirements.yml --roles-path "/usr/share/ansible/roles" 36 | RUN ANSIBLE_GALAXY_DISABLE_GPG_VERIFY=1 ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS -r requirements.yml --collections-path "/usr/share/ansible/collections" 37 | 38 | # Builder build stage 39 | FROM base as builder 40 | WORKDIR /build 41 | ARG EE_BASE_IMAGE 42 | ARG EE_BUILDER_IMAGE 43 | ARG PYCMD 44 | ARG PKGMGR_PRESERVE_CACHE 45 | ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS 46 | ARG ANSIBLE_GALAXY_CLI_ROLE_OPTS 47 | 48 | RUN $PYCMD -m pip install --no-cache-dir bindep pyyaml requirements-parser 49 | 50 | COPY --from=galaxy /usr/share/ansible /usr/share/ansible 51 | 52 | RUN $PYCMD /output/scripts/introspect.py introspect --sanitize --write-bindep=/tmp/src/bindep.txt --write-pip=/tmp/src/requirements.txt 53 | RUN /output/scripts/assemble 54 | 55 | # Final build stage 56 | FROM base as final 57 | ARG EE_BASE_IMAGE 58 | ARG EE_BUILDER_IMAGE 59 | ARG PYCMD 60 | ARG PKGMGR_PRESERVE_CACHE 61 | ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS 62 | ARG ANSIBLE_GALAXY_CLI_ROLE_OPTS 63 | 64 | 65 | COPY --from=galaxy /usr/share/ansible /usr/share/ansible 66 | 67 | COPY --from=builder /output/ /output/ 68 | RUN /output/scripts/install-from-bindep && rm -rf /output/wheels 69 | RUN rm -rf /output 70 | LABEL ansible-execution-environment=true 71 | -------------------------------------------------------------------------------- /build_context/_build/requirements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | collections: 3 | - community.general 4 | - ansible.posix 5 | - infra.osbuild 6 | - git+https://github.com/redhat-cop/edge.microshift.git 7 | -------------------------------------------------------------------------------- /changelogs/changelog.yaml: -------------------------------------------------------------------------------- 1 | ancestor: null 2 | releases: 3 | 1.0.0: 4 | changes: 5 | bugfixes: 6 | - image_builder - change compose_type to builder_compose_type to pass the value 7 | to osbuild builder role 8 | - image_builder - fix issue where iso fails to auto install 9 | - image_builder - pass sshkey instead of the file path 10 | - image_builder - update lvms namespace to match the collections namespace 11 | - image_builder - updated microshift_kickstart_post variable to fix issue with 12 | omit in kickstart post 13 | major_changes: 14 | - image_builder - Added ability to configure ovs-kubernetes and crio proxy 15 | - image_builder - add rhsm repo support 16 | - image_builder - added ability to provide pull secrets to kickstart 17 | - image_builder - added app role to deploy manifests onto microshift system 18 | - image_builder - added default firewall option for mandatory microshift rules 19 | and ability to create additional port/sources for zones 20 | - image_builder - added rpm_install role to automate the install for microshift 21 | on rpm based systems 22 | - image_builder - added storage config to kickstart file 23 | - image_builder - created new image builder role to create image with microshift 24 | and necessary bits baked in 25 | minor_changes: 26 | - image_builder - add playbook to deploy demo app to microshift 27 | - image_builder - add rhsm repo var for rhocp & fast_datapath_for_rhel 28 | - image_builder - content readme updated 29 | - image_builder - create set_fact loop to set fact in a DRY way 30 | - image_builder - relocate rhsm_repos_info management to infra.osbuild 31 | - image_builder - used latest version for osbuild 32 | - image_builder - uses the new updated way of adding kickstart post to osbuild 33 | additional_kickstart_post var 34 | - microshift_e2e_test - add microshift test playbook 35 | fragments: 36 | - 1-create-microshift-image.yaml 37 | - 10-fix-iso-auto-install.yaml 38 | - 11-pass-sshkey.yaml 39 | - 12-update-lvms-namespace.yaml 40 | - 14-rhsm-repo.yaml 41 | - 15-provide-pull-secrets-to-kickstart.yaml 42 | - 16-fix-kickstart-post-omit-issue.yaml 43 | - 17-create-set-fact-loop.yaml 44 | - 18-microshift-test-playbook.yaml 45 | - 19-update-galaxy-file.yaml 46 | - 2-updated-readme-with-basic-info.yaml 47 | - 24-used-latest-version-for-osbuild.yaml 48 | - 25-removed-dependencies.yaml 49 | - 26-updated-galaxy-dependencies.yaml 50 | - 27-add-playbook-to-deploy-demo-app-to-microshift.yaml 51 | - 28-fix-lint-issues.yaml 52 | - 29-changed-how-kickstart-post-is-used.yaml 53 | - 3-change-compose-type-to-builder-compose-type.yaml 54 | - 30-add-app-role-to-deploy-manifests-onto-microshift-systems.yaml 55 | - 31-add-rhsm-repo-var-for-rhocp-and-fast-datapath-for-rhel.yaml 56 | - 32-relocate-rhsm-repos-info-management-to-infra.osbuild.yaml 57 | - 35-add-rpm-install-role.yaml 58 | - 36-codeowners.yaml 59 | - 37-content-readme.yaml 60 | - 4-firewall-config.yaml 61 | - 6-inject-ovs-kub-crio-config-into-kickstart.yaml 62 | - 7-add-storage-config-to-kickstart.yaml 63 | release_date: '2023-06-21' 64 | 1.0.1: 65 | changes: 66 | minor_changes: 67 | - Replace system roles with community.general 68 | - Update OSBuild dependency from git to Galaxy 69 | fragments: 70 | - 41-ansible-lint-github-workflows.yaml 71 | - 45-publish-trigger-github-workflow.yaml 72 | - 46-replace-system-roles.yaml 73 | - 47-add-release-workflow.yaml 74 | - 48-fix-readme-&-galaxy.yaml 75 | - 49-delete-unsued-docs-dir.yaml 76 | - 51-update-osbuild-from-git-to-galaxy.yaml 77 | - 52-update-new-repo-location.yaml 78 | release_date: '2023-06-29' 79 | 1.0.3: 80 | changes: 81 | minor_changes: 82 | - Fix builder_compose_pkgs bug, update Microshift to 4.13 83 | fragments: 84 | - 54-release-1.0.2.yaml 85 | - 56-add-execution-environment.yaml 86 | - 57-add-defaults-to-all-ifs.yaml 87 | - 61-fix-pkg-bug-update-Microshift-to-4_13.yaml 88 | release_date: '2023-08-03' 89 | -------------------------------------------------------------------------------- /changelogs/config.yaml: -------------------------------------------------------------------------------- 1 | changelog_filename_template: ../CHANGELOG.rst 2 | changelog_filename_version_depth: 0 3 | changes_file: changelog.yaml 4 | changes_format: combined 5 | keep_fragments: false 6 | mention_ancestor: true 7 | new_plugins_after_name: removed_features 8 | notesdir: fragments 9 | prelude_section_name: release_summary 10 | prelude_section_title: Release Summary 11 | sections: 12 | - - major_changes 13 | - Major Changes 14 | - - minor_changes 15 | - Minor Changes 16 | - - breaking_changes 17 | - Breaking Changes / Porting Guide 18 | - - deprecated_features 19 | - Deprecated Features 20 | - - removed_features 21 | - Removed Features (previously deprecated) 22 | - - security_fixes 23 | - Security Fixes 24 | - - bugfixes 25 | - Bugfixes 26 | - - known_issues 27 | - Known Issues 28 | title: CHANGE THIS IN changelogs/config.yaml! 29 | trivial_section_name: trivial 30 | -------------------------------------------------------------------------------- /changelogs/fragments/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-cop/edge.microshift/6fe93848e3dcfc30a42967478830c3e4251c4b9b/changelogs/fragments/.keep -------------------------------------------------------------------------------- /changelogs/fragments/63-add-default-skip-lvms-in-kickstart-post.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | minor_changes: 3 | - Add default to skip lvms in kickstart post 4 | -------------------------------------------------------------------------------- /changelogs/fragments/64-fix-kickstart-post-to-match-convention.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | minor_changes: 3 | - Fix kickstart post to match convention 4 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | # CHANGE THIS 2 | fixes: 3 | - "/ansible_collections/NAMESPACE/COLLECTION/::" 4 | -------------------------------------------------------------------------------- /execution-environment.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 1 3 | 4 | build_arg_defaults: 5 | EE_BASE_IMAGE: 'quay.io/ansible/ansible-runner:latest' 6 | 7 | dependencies: 8 | galaxy: build_context/_build/requirements.yml 9 | -------------------------------------------------------------------------------- /galaxy.yml: -------------------------------------------------------------------------------- 1 | ### REQUIRED 2 | 3 | # The namespace of the collection. This can be a company/brand/organization or product namespace under which all 4 | # content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with 5 | # underscores or numbers and cannot contain consecutive underscores 6 | namespace: edge 7 | 8 | # The name of the collection. Has the same character restrictions as 'namespace' 9 | name: microshift 10 | 11 | # The version of the collection. Must be compatible with semantic versioning 12 | version: 1.0.3 13 | 14 | # The path to the Markdown (.md) readme file. This path is relative to the root of the collection 15 | readme: README.md 16 | 17 | # A list of the collection's content authors. Can be just the name or in the format 'Full Name (url) 18 | # @nicks:irc/im.site#channel' 19 | authors: 20 | - Adam Miller (@maxamillion) 21 | - Chris Santiago (@resoluteCoder) 22 | - Matthew Sandoval (@matoval) 23 | 24 | ### OPTIONAL but strongly recommended 25 | 26 | # A short summary description of the collection 27 | description: Collection for management and automation of microshift 28 | 29 | # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only 30 | # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' 31 | # license: 32 | # - GPL-3.0-or-later 33 | 34 | # The path to the license file for the collection. This path is relative to the root of the collection. This key is 35 | # mutually exclusive with 'license' 36 | license_file: LICENSE 37 | 38 | # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character 39 | # requirements as 'namespace' and 'name' 40 | tags: ['infrastructure'] 41 | 42 | # Collections that this collection requires to be installed for it to be usable. The key of the dict is the 43 | # collection label 'namespace.name'. The value is a version range 44 | # L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version 45 | # range specifiers can be set and are separated by ',' 46 | 47 | dependencies: 48 | "infra.osbuild": ">2.0.0" 49 | "community.general": ">1.0.0" 50 | 51 | # The URL of the originating SCM repository 52 | repository: https://github.com/redhat-cop/edge.microshift 53 | 54 | # The URL to any online docs 55 | documentation: https://github.com/redhat-cop/edge.microshift/blob/main/README.md 56 | 57 | # The URL to the homepage of the collection/project 58 | homepage: https://github.com/redhat-cop/edge.microshift 59 | 60 | # The URL to the collection issue tracker 61 | issues: https://github.com/redhat-cop/edge.microshift/issues 62 | -------------------------------------------------------------------------------- /meta/runtime.yml: -------------------------------------------------------------------------------- 1 | --- 2 | requires_ansible: '>=2.11.0' # Use '>=2.9.10' instead, if needed 3 | -------------------------------------------------------------------------------- /playbooks/microshift_app.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Deploy application on microshift 3 | hosts: all 4 | tasks: 5 | - name: Deploy application 6 | ansible.builtin.import_role: 7 | name: edge.microshift.app 8 | -------------------------------------------------------------------------------- /playbooks/microshift_image_build.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Run microshift image builder role 3 | become: true 4 | hosts: all 5 | gather_facts: true 6 | tasks: 7 | - name: Create image with microshift 8 | ansible.builtin.import_role: 9 | name: edge.microshift.image_builder 10 | -------------------------------------------------------------------------------- /playbooks/microshift_rpm_install.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Run Microshift rpm install role 3 | hosts: all 4 | gather_facts: true 5 | tasks: 6 | - name: Install Microshift on rpm based system 7 | ansible.builtin.import_role: 8 | name: edge.microshift.rpm_install 9 | -------------------------------------------------------------------------------- /requirements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | collections: 3 | - community.general 4 | - ansible.posix 5 | - infra.osbuild 6 | -------------------------------------------------------------------------------- /roles/app/README.md: -------------------------------------------------------------------------------- 1 | # edge.microshift.app 2 | 3 | This role deploys application onto a system running microshift. 4 | 5 | ## Requirements 6 | 7 | The role requires a system to be running microshift which 8 | the `edge.microshift.image_build` role will automate the creation of. 9 | 10 | ## Role Variables 11 | 12 | ### microshift_image_pull_secret 13 | 14 | Type: file / string 15 | Required: true 16 | 17 | Pull secret allows authentication with the container registries that serve the container images used by the official Red Hat supported MicroShift. 18 | 19 | For downloading the pull secret from the Red Hat Hybrid Cloud Console, click [here](https://console.redhat.com/openshift/install/pull-secret) 20 | 21 | **Note:** If the pull secret is not on the microshift system then the pull secret will need to be set and defined in the playbook. 22 | 23 | Example: 24 | ```yaml 25 | microshift_image_pull_secret: "{{ lookup('file', '~/pull-secret.txt') }}" 26 | ``` 27 | 28 | ### microshift_app_manifests 29 | 30 | Type: complex 31 | Required: true 32 | 33 | Application manifest files to be deployed on a microshift system. 34 | 35 | Example: 36 | 37 | ```yaml 38 | microshift_app_manifests: 39 | - /path/to/manifest1.yaml 40 | - /path/to/manifest2.yaml 41 | ``` 42 | 43 | ## Variables Exported by the Role 44 | 45 | None. 46 | 47 | ## Dependencies 48 | 49 | None. 50 | 51 | ## Example Playbook 52 | 53 | ```yaml 54 | --- 55 | - name: Deploy application on microshift 56 | hosts: all 57 | tasks: 58 | - name: Deploy application 59 | vars: 60 | microshift_image_pull_secret: "{{ lookup('file', '~/pull-secret.txt') }}" 61 | microshift_app_manifests: 62 | - /manifests/deployment.yaml 63 | - /manifests/kustomization.yaml 64 | - /manifests/namespace.yaml 65 | - /manifests/route.yaml 66 | - /manifests/service.yaml 67 | ansible.builtin.import_role: 68 | name: edge.microshift.app 69 | ``` 70 | 71 | 72 | ## License 73 | 74 | GPLv3 75 | -------------------------------------------------------------------------------- /roles/app/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for app 3 | -------------------------------------------------------------------------------- /roles/app/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for app 3 | - name: Restart microshift 4 | ansible.builtin.systemd: 5 | service: microshift 6 | state: restarted 7 | -------------------------------------------------------------------------------- /roles/app/meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | role_name: "app" 4 | standalone: false 5 | company: "Red Hat" 6 | description: "Deploy an application onto a system running microshift" 7 | author: Ansible Edge Working Group 8 | license: "GPL-3.0-or-later" 9 | min_ansible_version: "2.12" 10 | platforms: 11 | - name: "EL" 12 | versions: 13 | - "8" 14 | - "9" 15 | - name: "Fedora" 16 | versions: 17 | - "all" 18 | galaxy_tags: 19 | - "microshift" 20 | - "app" 21 | dependencies: [] 22 | -------------------------------------------------------------------------------- /roles/app/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for app 3 | - name: Get non root user dir 4 | ansible.builtin.set_fact: 5 | ansible_non_root_user_dir: "{{ ansible_user_dir }}" 6 | 7 | - name: Setup and deploy app 8 | become: true 9 | block: 10 | - name: Check for microshift pull secret exists on system 11 | ansible.builtin.stat: 12 | path: /etc/crio/openshift-pull-secret 13 | register: stat_output 14 | 15 | - name: Conditional create microshift pull secret 16 | when: not stat_output.stat.exists 17 | block: 18 | - name: Assert microshift pull secret is defined 19 | ansible.builtin.assert: 20 | that: 21 | - microshift_image_pull_secret is defined 22 | msg: "Microshift pull secret needs to be defined for app deployment" 23 | - name: Create microshift pull secret file on system 24 | ansible.builtin.copy: 25 | dest: /etc/crio/openshift-pull-secret 26 | content: "{{ microshift_image_pull_secret }}" 27 | owner: root 28 | mode: "0600" 29 | 30 | - name: Ensure manifest directory exists 31 | ansible.builtin.file: 32 | path: /etc/microshift/manifests 33 | state: directory 34 | mode: "0755" 35 | 36 | - name: Copy manifests to microshift system 37 | loop: "{{ microshift_app_manifests }}" 38 | ansible.builtin.copy: 39 | src: "{{ item }}" 40 | dest: "/etc/microshift/manifests/{{ item | ansible.builtin.basename }}.yaml" 41 | mode: "0644" 42 | notify: Restart microshift 43 | -------------------------------------------------------------------------------- /roles/app/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /roles/app/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Test app role 3 | hosts: localhost 4 | remote_user: root 5 | roles: 6 | - app 7 | -------------------------------------------------------------------------------- /roles/app/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for app 3 | -------------------------------------------------------------------------------- /roles/image_builder/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | This role automates the setup server and [osbuild](https://www.osbuild.org/) [compose builds](https://www.osbuild.org/guides/user-guide/user-guide.html) using the osbuild backend [Weldr](https://weldr.io/) API with Microshift and necessary dependencies installed. 5 | 6 | Requirements 7 | ------------ 8 | 9 | None 10 | 11 | Role Variables 12 | -------------- 13 | 14 | ## microshift_rhsm_repos 15 | 16 | Type: list 17 | Required: false 18 | 19 | *Use microshift_rhsm_repos to set the rhsm repos used for the Microshift package* 20 | 21 | List of [RHSM](https://access.redhat.com/products/red-hat-subscription-management/) repositories to make available to the 22 | [osbuild](https://www.osbuild.org/) [compose builds](https://www.osbuild.org/guides/user-guide/user-guide.html). 23 | 24 | Example: 25 | 26 | ```yaml 27 | microshift_rhsm_repos: 28 | - "rhocp-4.12-for-rhel-{{ ansible_distribution_major_version }}-{{ ansible_architecture }}-rpms" 29 | - "fast-datapath-for-rhel-{{ ansible_distribution_major_version }}-{{ ansible_architecture }}-rpms" 30 | ``` 31 | 32 | ## microshift_image_custom_repos 33 | 34 | Type: list 35 | Required: false 36 | 37 | *Use microshift_image_custom_repos to use community repos for the Microshift package* 38 | 39 | List of custom repositories to make available to the 40 | [osbuild](https://www.osbuild.org/) [compose builds](https://www.osbuild.org/guides/user-guide/user-guide.html). 41 | 42 | Example: 43 | 44 | ```yaml 45 | microshift_image_custom_repos: 46 | - name: EPEL8 47 | base_url: "https://dl.fedoraproject.org/pub/epel/{{ hostvars[inventory_hostname].ansible_distribution_major_version }}/Everything/x86_64/" 48 | type: yum-baseurl 49 | check_ssl: true 50 | check_gpg: false 51 | - name: microshift 52 | base_url: https://download.copr.fedorainfracloud.org/results/@redhat-et/microshift-testing/epel-8-x86_64/ 53 | type: yum-baseurl 54 | check_ssl: true 55 | check_gpg: false 56 | - name: microshift-deps 57 | base_url: https://mirror.openshift.com/pub/openshift-v4/x86_64/dependencies/rpms/4.12-el8-beta/ 58 | type: yum-baseurl 59 | check_ssl: true 60 | check_gpg: false 61 | ``` 62 | 63 | ### microshift_image_blueprint_name 64 | 65 | Type: string 66 | Required: false 67 | 68 | This is the name of the [osbuild blueprint](https://www.osbuild.org/guides/blueprint-reference/blueprint-reference.html?highlight=distro#distribution-selection-with-blueprints) 69 | to use. The blueprint will be auto generated based on the contents of the 70 | `microshift_image_compose_customizations` role variable. In the event an of an [rpm-ostree](https://rpm-ostree.readthedocs.io/en/stable/) 71 | based compose type specified by the `microshift_image_compose_type` role variable, the 72 | blueprint name defined in this variable will use used to define the resulting [ostree](https://ostreedev.github.io/ostree/) 73 | repository. 74 | 75 | ### microshift_image_blueprint_src_path 76 | 77 | Type: string 78 | Required: false 79 | 80 | This is the path to a location on the osbuild server that the generated 81 | blueprint should be stored at and used as the source content for the osbuild 82 | compose build. 83 | 84 | ### microshift_image_compose_type 85 | 86 | Type: string 87 | Required: false 88 | 89 | This variable defines the type of compose desired, valid inputs will vary based 90 | on operating system (RHEL, CentOS Stream, or Fedora) and release version therin. 91 | 92 | For RHEL, the Red Hat Enterprise Linux Documentation Team publishes these and they can be found [here](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/composing_a_customized_rhel_system_image/index#composer-output-formats_composer-description). 93 | 94 | For CentOS Stream and Fedora, you will need to reference the output of the 95 | `composer-cli compose types` command on the osbuild server (this can also be 96 | done on RHEL if preferred). 97 | 98 | ### microshift_image_pubkey 99 | 100 | Type: string 101 | Required: false 102 | 103 | Ssh public key to inject into the resulting image to allow 104 | key-based ssh functionality without extra configuration for systems installed 105 | with the resulting build media. If needed, use lookup to to get the contents from the public ssh key file. 106 | 107 | Example: 108 | ```yaml 109 | microshift_image_pubkey: "{{ lookup('file', '~/.ssh/id_rsa.pub', errors='warn') }}" 110 | ``` 111 | 112 | ### microshift_image_compose_customizations: 113 | 114 | Type: dict 115 | Required: false 116 | 117 | This variable is the YAML dict expression of 118 | [osbuild blueprint](https://www.osbuild.org/guides/blueprint-reference/blueprint-reference.html) customizations. 119 | 120 | Example: 121 | ```yaml 122 | microshift_image_compose_customizations: 123 | user: 124 | name: "testuser" 125 | description: "test user" 126 | password: "testpassword" 127 | key: "{{ microshift_image_pubkey_file }}" 128 | groups: '["users", "wheel"]' 129 | kernel: 130 | append: "nomst=force" 131 | services: 132 | enabled: ["firewalld"] 133 | firewalld.services: 134 | enabled: ["ssh", "https"] 135 | 136 | ``` 137 | 138 | ### microshift_image_firewall_options 139 | 140 | Type: complex 141 | Required: false 142 | 143 | Custom list of firewall options 144 | 145 | Each list entry is a [YAML dictionary](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) 146 | type and has the following attributes: 147 | 148 | | Variable Name | Type | Required | Default Value | 149 | |---------------|-----------------------------------|-----------|---------------| 150 | | zone | string | **Yes** | n/a | 151 | | source | string | **Yes** | n/a | 152 | | port | string | **Yes** | n/a | 153 | 154 | NOTES: 155 | 156 | Only either source or port can be used at a time. 157 | 158 | Example: 159 | 160 | ```yaml 161 | microshift_image_firewall_options: 162 | - zone: trusted 163 | source: 169.254.169.1 164 | - zone: trusted 165 | port: 443/tcp 166 | ``` 167 | 168 | ### microshift_image_lvms_pvc_name 169 | 170 | Type: string 171 | Required: false 172 | 173 | Name used for PVC metadata 174 | 175 | Example: 176 | 177 | ```yaml 178 | microshift_image_lvms_pvc_name: my-lv-pvc 179 | ``` 180 | 181 | ### microshift_image_lvms_pvc_access_modes 182 | 183 | Type: string 184 | Required: false 185 | 186 | Access mode of the PVC 187 | 188 | Example: 189 | ```yaml 190 | microshift_image_lvms_pvc_access_modes: ReadWriteOnce 191 | ``` 192 | 193 | ### microshift_image_lvms_pvc_storage 194 | 195 | Type: string 196 | Required: false 197 | 198 | PVC storage size 199 | 200 | Example: 201 | ```yaml 202 | microshift_image_lvms_pvc_storage: 1G 203 | ``` 204 | 205 | ### microshift_image_lvms_pod_name 206 | 207 | Type: string 208 | Required: false 209 | 210 | Name used for pod metadata 211 | 212 | Example: 213 | ```yaml 214 | microshift_image_lvms_pod_name: my-pod 215 | ``` 216 | 217 | ### microshift_image_lvms_pod_containers 218 | 219 | Type: dict 220 | Required: false 221 | 222 | Containers spec 223 | 224 | Example: 225 | ```yaml 226 | microshift_image_lvms_pod_containers: 227 | name: nginx 228 | image: nginx 229 | command: '["/usr/bin/sh". "-c"]' 230 | args: '["sleep", "1h"]' 231 | volumeMounts: 232 | mountPath: /mnt 233 | name: my-volume 234 | ``` 235 | 236 | ### microshift_image_lvms_pod_volumes 237 | 238 | Type: string 239 | Required: false 240 | 241 | Volumes spec 242 | 243 | Example: 244 | ```yaml 245 | microshift_image_lvms_pod_volumes: 246 | name: my-volume 247 | claimName: my-lv-pvc 248 | ``` 249 | 250 | ### microshift_image_gateway_interface 251 | 252 | Type: string 253 | Required: false 254 | 255 | Ingress that is the API gateway 256 | 257 | Example: 258 | ```yaml 259 | microshift_image_gateway_interface: eth0 260 | ``` 261 | 262 | ### microshift_image_external_gateway_interface 263 | 264 | Type: string 265 | Required: false 266 | 267 | Ingress routing external traffic to your services and pods inside the node 268 | 269 | Example: 270 | ```yaml 271 | microshift_image_external_gateway_interface: eth1 272 | ``` 273 | 274 | ### microshift_image_mtu 275 | 276 | Type: string 277 | Required: false 278 | 279 | 280 | 281 | MTU value used for the pods 282 | 283 | Example: 284 | ```yaml 285 | microshift_image_mtu: 1400 286 | ``` 287 | 288 | ### microshift_image_crio_proxy 289 | 290 | Type: complex 291 | Required: false 292 | 293 | Options for deploying a microshift cluster behind an http(s) proxy 294 | 295 | microshift_image_crio_proxy is a [YAML dictionary](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) 296 | type and has the following attributes: 297 | 298 | | Variable Name | Type | Required | Default Value | 299 | |---------------|-----------------------------------|-----------|---------------| 300 | | user | string | **Yes** | n/a | 301 | | password | string | **Yes** | n/a | 302 | | server | string | **Yes** | n/a | 303 | | port | string | **Yes** | n/a | 304 | 305 | NOTES: 306 | 307 | Using this option will inject credentials into kickstart that is exposed via http 308 | 309 | Example: 310 | 311 | ```yaml 312 | microshift_image_crio_proxy: 313 | user: user1 314 | password: pass1 315 | server: 192.183.3.333 316 | port: 123 317 | ``` 318 | 319 | ### microshift_image_pull_secret 320 | 321 | Type: file / string 322 | Required: false 323 | 324 | Pull secret allows authentication with the container registries that serve the container images used by the official Red Hat supported MicroShift. 325 | 326 | For downloading the pull secret from the Red Hat Hybrid Cloud Console, click [here](https://console.redhat.com/openshift/install/pull-secret) 327 | 328 | Example: 329 | ```yaml 330 | microshift_image_pull_secret: "{{ lookup('file', '~/pull-secret') }}" 331 | ``` 332 | 333 | Dependencies 334 | ------------ 335 | 336 | None 337 | 338 | Example Playbook 339 | ---------------- 340 | 341 | Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: 342 | 343 | --- 344 | - name: Run microshift image builder role 345 | become: true 346 | hosts: all 347 | gather_facts: true 348 | tasks: 349 | - name: Create image with microshift 350 | ansible.builtin.import_role: 351 | name: edge.microshift.image_builder 352 | 353 | License 354 | ------- 355 | 356 | GPLv3 357 | -------------------------------------------------------------------------------- /roles/image_builder/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for image_builder 3 | microshift_image_blueprint_name: microshift 4 | microshift_image_blueprint_src_path: "/tmp/microshift.toml" 5 | microshift_image_compose_type: edge-installer 6 | microshift_image_pubkey: "{{ lookup('file', '~/.ssh/id_rsa.pub', errors='warn') }}" 7 | microshift_image_compose_customizations: 8 | services: 9 | enabled: 10 | - "microshift" 11 | user: 12 | name: "edge" 13 | description: "test user" 14 | password: "openshift" 15 | key: "{{ microshift_image_pubkey }}" 16 | groups: 17 | - 'users' 18 | - 'wheel' 19 | microshift_kickstart_post: 20 | - "{{ microshift_image_firewall_options_template | default(none) }}" 21 | - "{{ microshift_image_lvms_setup_template | default(none) }}" 22 | - "{{ microshift_image_ovn_options_template | default(None) }}" 23 | - "{{ microshift_image_crio_proxy_template | default(None) }}" 24 | - "{{ microshift_image_pull_secret_template | default(None) }}" 25 | microshift_kickstart_options: 26 | - lang en_US.UTF-8 27 | - keyboard us 28 | - timezone Etc/UTC 29 | - text 30 | - zerombr 31 | - clearpart --all --initlabel 32 | - part /boot/efi --fstype=efi --size=200 33 | - part /boot --fstype=xfs --asprimary --size=800 34 | - part swap --fstype=swap --recommended 35 | - part pv.01 --grow 36 | - volgroup rhel pv.01 37 | - logvol / --vgname=rhel --fstype=xfs --size=10000 --name=root 38 | - reboot 39 | - network --bootproto=dhcp 40 | - user --name={{ builder_compose_customizations['user']['name'] }} {{ "--password" if builder_password is defined }} {{ builder_password if builder_password is defined }} --group=wheel,user # noqa yaml[line-length] 41 | - ostreesetup --nogpg --osname=rhel --remote=edge --url=http://{{ ansible_host }}/{{ builder_blueprint_name }}/repo/ --ref={{ builder_blueprint_ref }} 42 | microshift_image_compose_pkgs: 43 | - microshift 44 | - NetworkManager-wifi 45 | - firewalld 46 | - git 47 | - openshift-clients 48 | microshift_image_firewall_options: 49 | # network_access_to_pods (mandatory) 50 | - zone: trusted 51 | source: 10.42.0.0/16 52 | # network_access_to_services (mandatory) 53 | - zone: trusted 54 | source: 169.254.169.1 55 | -------------------------------------------------------------------------------- /roles/image_builder/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for image_builder 3 | -------------------------------------------------------------------------------- /roles/image_builder/meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | role_name: "image_builder" 4 | standalone: false 5 | company: "Red Hat" 6 | description: "Build an operating system image using osbuild composer with microshift and depencies installed" 7 | author: Ansible Edge Working Group 8 | license: "GPL-3.0-or-later" 9 | min_ansible_version: "2.12" 10 | platforms: 11 | - name: "EL" 12 | versions: 13 | - "8" 14 | galaxy_tags: 15 | - "image" 16 | - "build" 17 | - "os" 18 | - "microshift" 19 | - "openshift" 20 | - "kubernetes" 21 | dependencies: [] 22 | -------------------------------------------------------------------------------- /roles/image_builder/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for image_builder 3 | - name: Setup osbuild server 4 | ansible.builtin.import_role: 5 | name: infra.osbuild.setup_server 6 | 7 | - name: Conditionally set Osbuild vars 8 | when: item.value is defined 9 | ansible.builtin.set_fact: "{{ item.name }}: {{ item.value }}" 10 | loop: 11 | - { name: microshift_image_ovn_options_template, value: "{{ lookup('ansible.builtin.template', '../templates/ovn_options.j2') if microshift_image_gateway_interface is defined or microshift_image_external_gateway_interface is defined or microshift_image_mtu is defined | default(None) }}" } # noqa yaml[line-length] 12 | - { name: microshift_image_crio_proxy_template, value: "{{ lookup('ansible.builtin.template', '../templates/crio_proxy.j2') if microshift_image_crio_proxy is defined | default(None) }}" } # noqa yaml[line-length] 13 | - { name: microshift_image_pull_secret_template, value: "{{ lookup('ansible.builtin.template', '../templates/pull_secret.j2') if microshift_image_pull_secret is defined | default(None) }}" } # noqa yaml[line-length] 14 | - { name: microshift_image_firewall_options_template, value: "{{ lookup('ansible.builtin.template', '../templates/firewall_options.j2') if microshift_image_firewall_options is defined | default(None) }}" } # noqa yaml[line-length] 15 | - { name: microshift_image_lvms_setup_template, value: "{{ lookup('ansible.builtin.template', '../templates/lvms_setup.j2') if microshift_image_lvms_pvc_name is defined | default(None) }}" } # noqa yaml[line-length] 16 | 17 | - name: Running osbuild image builder 18 | become: true 19 | ansible.builtin.import_role: 20 | name: infra.osbuild.builder 21 | vars: 22 | builder_custom_repos: "{{ microshift_image_custom_repos | default([]) }}" # noqa var-naming[no-role-prefix] 23 | builder_blueprint_name: "{{ microshift_image_blueprint_name }}" 24 | builder_blueprint_src_path: "{{ microshift_image_blueprint_src_path }}" 25 | builder_compose_type: "{{ microshift_image_compose_type }}" 26 | pubkey_file: "{{ microshift_image_pubkey }}" 27 | builder_compose_customizations: "{{ microshift_image_compose_customizations }}" 28 | additional_kickstart_post: "{{ microshift_kickstart_post }}" 29 | builder_kickstart_options: "{{ microshift_kickstart_options }}" 30 | builder_rhsm_repos: "{{ microshift_rhsm_repos }}" 31 | builder_compose_pkgs: "{{ microshift_image_compose_pkgs }}" # noqa var-naming[no-role-prefix] 32 | -------------------------------------------------------------------------------- /roles/image_builder/templates/crio_proxy.j2: -------------------------------------------------------------------------------- 1 | mkdir /etc/systemd/system/crio.service.d/ 2 | cat > /etc/systemd/system/crio.service.d/00-proxy.conf < /etc/microshift/ovn.yaml < /etc/crio/openshift-pull-secret <