A Kubernetes deployment for managing Ansible Execution Environments through the Cray Configuration Framework Service. A Config Framework Session manages the setup, launch, and teardown of Ansible Execution Environments (AEE) and provides status information from the AEE runs.
Unit tests are run via nox using pytest.
(cfs-operator) $ nox -s unittestsUnit tests are located in the tests/unit directory and should be added for all code in this repository. Code coverage is calculated during this nox session as well.
NOTE: Pipeline builds and local runs of the unit tests will fail if the coverage is less than 95%.
Code style is checked with flake8 using nox:
(cfs-operator) $ nox -s lintThe flake8 configuration file is located in .flake8.
NOTE: Pipeline builds and local runs of flake8 will fail if linting issues are present.
The operator is deployed as part of the CSM System Management manifest on Cray Shasta systems.
cfs-operator uses the cray-aee image built by the ansible-execution-environment repo. We specify which major and minor version of the image we want with the update_external_versions.conf file. At build time the latest version with that major and minor number is found.
When creating a new release branch, be sure to update this file to specify the desired major and minor number of the image for the new release.
This repo uses some build helpers from the cms-meta-tools repo. See that repo for more details.
If you wish to perform a local build, you will first need to clone or copy the contents of the
cms-meta-tools repo to ./cms_meta_tools in the same directory as the Makefile. When building
on github, the cloneCMSMetaTools() function clones the cms-meta-tools repo into that directory.
For a local build, you will also need to manually write the .version, .docker_version (if this repo builds a docker image), and .chart_version (if this repo builds a helm chart) files. When building on github, this is done by the setVersionFiles() function.
Members of the CASMCMS team should provide a pull request to master and/or a release branch. Others should fork this repository and provide a pull request to the current release branch.
- Randy Kleinman - Q1 2019 - Initial Work - rkleinman@cray.com
- (Add your name here for praise or blame later)
See the CHANGELOG for changes. This file uses the Keep A Changelog format.
This project is copyrighted by Hewlett Packard Enterprise Development LP and is under the MIT license. See the LICENSE file for details.
When making any modifications to a file that has a Cray/HPE copyright header, that header must be updated to include the current year.
When creating any new files in this repo, if they contain source code, they must have the HPE copyright and license text in their header, unless the file is covered under someone else's copyright/license (in which case that should be in the header). For this purpose, source code files include Dockerfiles, Ansible files, RPM spec files, and shell scripts. It does not include Jenkinsfiles, OpenAPI/Swagger specs, or READMEs.
When in doubt, provided the file is not covered under someone else's copyright or license, then it does not hurt to add ours to the header.