From a424ad3d645763d38dcb13ae3267874bd6fb7384 Mon Sep 17 00:00:00 2001 From: Robert Church Date: Tue, 10 Sep 2019 15:04:23 -0400 Subject: [PATCH] Enable helm/armada plugin delivery with the application This creates a new package spec called python-k8sapp-platform that will build two packages: python-k8sapp-platform and python-k8sapp-platform-wheels. These packages will hold all the stevedore plugins needed to support the application. These packages are included in the build dependencies for the stx-platform-helm application package build where the wheels file will be included in the application tarball. The helm and armada plugins have been relocated to this repo and provided in a k8sapp_platform python module. This module will be extracted from the wheels and installed on the platform via the sysinv application framework. The module will be made available when the application is enabled. Now that the plugins and the application are residing in the same repository, GITREVCOUNT will be used to drive the package version of both to keep them in sync. Tox test support has been provided for the plugin module. Change-Id: I2085440cd23790ef49662b427d2e894b515b6f2a Depends-On: https://review.opendev.org/#/c/686971/ Story: 2006537 Task: 36931 Signed-off-by: Robert Church --- centos_pkg_dirs | 1 + python-k8sapp-platform/centos/build_srpm.data | 9 + .../centos/python-k8sapp-platform.spec | 65 ++++ .../k8sapp_platform/.gitignore | 35 +++ .../k8sapp_platform/.stestr.conf | 4 + .../k8sapp_platform/LICENSE | 202 ++++++++++++ .../k8sapp_platform/README.rst | 7 + .../k8sapp_platform/__init__.py | 5 + .../k8sapp_platform/armada/__init__.py | 19 ++ .../armada/manifest_platform.py | 40 +++ .../k8sapp_platform/common/__init__.py | 5 + .../k8sapp_platform/common/constants.py | 11 + .../k8sapp_platform/helm/__init__.py | 19 ++ .../k8sapp_platform/helm/ceph_pools_audit.py | 93 ++++++ .../k8sapp_platform/helm/helm_toolkit.py | 36 +++ .../k8sapp_platform/helm/rbd_provisioner.py | 104 +++++++ .../k8sapp_platform/tests/__init__.py | 5 + .../k8sapp_platform/tests/test_plugins.py | 40 +++ .../k8sapp_platform/pylint.rc | 287 ++++++++++++++++++ .../k8sapp_platform/requirements.txt | 3 + .../k8sapp_platform/setup.cfg | 44 +++ .../k8sapp_platform/setup.py | 12 + .../k8sapp_platform/test-requirements.txt | 28 ++ .../k8sapp_platform/tox.ini | 200 ++++++++++++ .../k8sapp_platform/upper-constraints.txt | 1 + stx-platform-helm/centos/build_srpm.data | 8 +- .../centos/stx-platform-helm.spec | 14 +- 27 files changed, 1293 insertions(+), 4 deletions(-) create mode 100644 python-k8sapp-platform/centos/build_srpm.data create mode 100644 python-k8sapp-platform/centos/python-k8sapp-platform.spec create mode 100644 python-k8sapp-platform/k8sapp_platform/.gitignore create mode 100644 python-k8sapp-platform/k8sapp_platform/.stestr.conf create mode 100644 python-k8sapp-platform/k8sapp_platform/LICENSE create mode 100644 python-k8sapp-platform/k8sapp_platform/README.rst create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/__init__.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/__init__.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/manifest_platform.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/__init__.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/constants.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/__init__.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/ceph_pools_audit.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/helm_toolkit.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/rbd_provisioner.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/__init__.py create mode 100644 python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/test_plugins.py create mode 100755 python-k8sapp-platform/k8sapp_platform/pylint.rc create mode 100644 python-k8sapp-platform/k8sapp_platform/requirements.txt create mode 100644 python-k8sapp-platform/k8sapp_platform/setup.cfg create mode 100644 python-k8sapp-platform/k8sapp_platform/setup.py create mode 100644 python-k8sapp-platform/k8sapp_platform/test-requirements.txt create mode 100644 python-k8sapp-platform/k8sapp_platform/tox.ini create mode 100644 python-k8sapp-platform/k8sapp_platform/upper-constraints.txt diff --git a/centos_pkg_dirs b/centos_pkg_dirs index cf5f980..587fb79 100644 --- a/centos_pkg_dirs +++ b/centos_pkg_dirs @@ -1 +1,2 @@ stx-platform-helm +python-k8sapp-platform diff --git a/python-k8sapp-platform/centos/build_srpm.data b/python-k8sapp-platform/centos/build_srpm.data new file mode 100644 index 0000000..98cea4a --- /dev/null +++ b/python-k8sapp-platform/centos/build_srpm.data @@ -0,0 +1,9 @@ +SRC_DIR="k8sapp_platform" + +# Bump The version to be one less that what the version was prior to decoupling +# as this will align the GITREVCOUNT value to increment the version by one. +# Remove this (i.e. reset to 0) on then next major version changes when +# TIS_BASE_SRCREV changes. This version should align with the version of the +# helm charts in stx-platform-helm +TIS_BASE_SRCREV=c608f2aaa92064b712e7076e4141a162b78fe995 +TIS_PATCH_VER=GITREVCOUNT+7 diff --git a/python-k8sapp-platform/centos/python-k8sapp-platform.spec b/python-k8sapp-platform/centos/python-k8sapp-platform.spec new file mode 100644 index 0000000..d770459 --- /dev/null +++ b/python-k8sapp-platform/centos/python-k8sapp-platform.spec @@ -0,0 +1,65 @@ +%global pypi_name k8sapp-platform +%global sname k8sapp_platform + +Name: python-%{pypi_name} +Version: 1.0 +Release: %{tis_patch_ver}%{?_tis_dist} +Summary: StarlingX sysinv extensions: Platform Integration K8S app + +License: Apache-2.0 +Source0: %{name}-%{version}.tar.gz + +BuildArch: noarch + +BuildRequires: python-setuptools +BuildRequires: python-pbr +BuildRequires: python2-pip +BuildRequires: python2-wheel + +%description +StarlingX sysinv extensions: Platform Integration K8S app + +%package -n python2-%{pypi_name} +Summary: StarlingX sysinv extensions: Platform Integration K8S app + +Requires: python-pbr >= 2.0.0 +Requires: sysinv >= 1.0 + +%description -n python2-%{pypi_name} +StarlingX sysinv extensions: Platform Integration K8S app + +%prep +%setup +# Remove bundled egg-info +rm -rf %{pypi_name}.egg-info + +%build +export PBR_VERSION=%{version} +%{__python2} setup.py build + +%py2_build_wheel + +%install +export PBR_VERSION=%{version}.%{tis_patch_ver} +export SKIP_PIP_INSTALL=1 +%{__python2} setup.py install --skip-build --root %{buildroot} +mkdir -p ${RPM_BUILD_ROOT}/plugins +install -m 644 dist/*.whl ${RPM_BUILD_ROOT}/plugins/ + +%files +%{python2_sitelib}/%{sname} +%{python2_sitelib}/%{sname}-*.egg-info + +%package wheels +Summary: %{name} wheels + +%description wheels +Contains python wheels for %{name} + +%files wheels +/plugins/* + + +%changelog +* Mon May 11 2020 Robert Church +- Initial version diff --git a/python-k8sapp-platform/k8sapp_platform/.gitignore b/python-k8sapp-platform/k8sapp_platform/.gitignore new file mode 100644 index 0000000..78c457c --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/.gitignore @@ -0,0 +1,35 @@ +# Compiled files +*.py[co] +*.a +*.o +*.so + +# Sphinx +_build +doc/source/api/ + +# Packages/installer info +*.egg +*.egg-info +dist +build +eggs +parts +var +sdist +develop-eggs +.installed.cfg + +# Other +*.DS_Store +.stestr +.testrepository +.tox +.venv +.*.swp +.coverage +bandit.xml +cover +AUTHORS +ChangeLog +*.sqlite diff --git a/python-k8sapp-platform/k8sapp_platform/.stestr.conf b/python-k8sapp-platform/k8sapp_platform/.stestr.conf new file mode 100644 index 0000000..3931130 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/.stestr.conf @@ -0,0 +1,4 @@ +[DEFAULT] +test_path=./k8sapp_platform/tests +top_dir=./k8sapp_platform +#parallel_class=True diff --git a/python-k8sapp-platform/k8sapp_platform/LICENSE b/python-k8sapp-platform/k8sapp_platform/LICENSE new file mode 100644 index 0000000..d6e2801 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Wind River Systems, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/python-k8sapp-platform/k8sapp_platform/README.rst b/python-k8sapp-platform/k8sapp_platform/README.rst new file mode 100644 index 0000000..91bad44 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/README.rst @@ -0,0 +1,7 @@ +k8sapp-platform +=============== + +This project contains StarlingX Kubernetes application specific python plugins +for the platform integration application. These plugins are required to +integrate the application into the StarlingX application framework and to +support the various StarlingX deployments. diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/__init__.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/__init__.py new file mode 100644 index 0000000..06cfada --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/__init__.py @@ -0,0 +1,5 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/__init__.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/__init__.py new file mode 100644 index 0000000..5587e5f --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/__init__.py @@ -0,0 +1,19 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +import yaml + + +class quoted_str(str): + pass + + +# force strings to be single-quoted to avoid interpretation as numeric values +def quoted_presenter(dumper, data): + return dumper.represent_scalar(u'tag:yaml.org,2002:str', data, style="'") + + +yaml.add_representer(quoted_str, quoted_presenter) diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/manifest_platform.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/manifest_platform.py new file mode 100644 index 0000000..efdc87e --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/armada/manifest_platform.py @@ -0,0 +1,40 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# +# All Rights Reserved. +# + +""" System inventory Armada manifest operator.""" + +from k8sapp_platform.helm.ceph_pools_audit import CephPoolsAuditHelm +from k8sapp_platform.helm.rbd_provisioner import RbdProvisionerHelm + +from sysinv.common import constants +from sysinv.helm import manifest_base as base + + +class PlatformArmadaManifestOperator(base.ArmadaManifestOperator): + + APP = constants.HELM_APP_PLATFORM + ARMADA_MANIFEST = 'platform-integration-manifest' + + CHART_GROUP_CEPH = 'starlingx-ceph-charts' + CHART_GROUPS_LUT = { + CephPoolsAuditHelm.CHART: CHART_GROUP_CEPH, + RbdProvisionerHelm.CHART: CHART_GROUP_CEPH + } + + CHARTS_LUT = { + CephPoolsAuditHelm.CHART: 'kube-system-ceph-pools-audit', + RbdProvisionerHelm.CHART: 'kube-system-rbd-provisioner' + } + + def platform_mode_manifest_updates(self, dbapi, mode): + """ Update the application manifest based on the platform + + :param dbapi: DB api object + :param mode: mode to control how to apply the application manifest + """ + pass diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/__init__.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/__init__.py new file mode 100644 index 0000000..06cfada --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/__init__.py @@ -0,0 +1,5 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/constants.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/constants.py new file mode 100644 index 0000000..04f5342 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/common/constants.py @@ -0,0 +1,11 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +# Helm: Supported charts: +# These values match the names in the chart package's Chart.yaml +HELM_CHART_RBD_PROVISIONER = 'rbd-provisioner' +HELM_CHART_CEPH_POOLS_AUDIT = 'ceph-pools-audit' +HELM_CHART_HELM_TOOLKIT = 'helm-toolkit' diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/__init__.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/__init__.py new file mode 100644 index 0000000..5587e5f --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/__init__.py @@ -0,0 +1,19 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +import yaml + + +class quoted_str(str): + pass + + +# force strings to be single-quoted to avoid interpretation as numeric values +def quoted_presenter(dumper, data): + return dumper.represent_scalar(u'tag:yaml.org,2002:str', data, style="'") + + +yaml.add_representer(quoted_str, quoted_presenter) diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/ceph_pools_audit.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/ceph_pools_audit.py new file mode 100644 index 0000000..aa1991c --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/ceph_pools_audit.py @@ -0,0 +1,93 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +from k8sapp_platform.common import constants as app_constants + +from sysinv.common import constants +from sysinv.common import exception + +from sysinv.helm import base +from sysinv.helm import common + + +class CephPoolsAuditHelm(base.BaseHelm): + """Class to encapsulate helm operations for the ceph-pools-audit chart""" + + CHART = app_constants.HELM_CHART_CEPH_POOLS_AUDIT + SUPPORTED_NAMESPACES = base.BaseHelm.SUPPORTED_NAMESPACES + \ + [common.HELM_NS_RBD_PROVISIONER] + SUPPORTED_APP_NAMESPACES = { + constants.HELM_APP_PLATFORM: + base.BaseHelm.SUPPORTED_NAMESPACES + [common.HELM_NS_RBD_PROVISIONER], + } + + SERVICE_NAME = 'ceph-pools' + + def execute_manifest_updates(self, operator): + # On application load this chart is enabled. Only disable if specified + # by the user + if not self._is_enabled(operator.APP, self.CHART, + common.HELM_NS_RBD_PROVISIONER): + operator.chart_group_chart_delete( + operator.CHART_GROUPS_LUT[self.CHART], + operator.CHARTS_LUT[self.CHART]) + + def get_namespaces(self): + return self.SUPPORTED_NAMESPACES + + def get_overrides(self, namespace=None): + + backends = self.dbapi.storage_backend_get_list() + ceph_bks = [bk for bk in backends if bk.backend == constants.SB_TYPE_CEPH] + + if not ceph_bks: + return {} # ceph is not configured + + monitors = self._get_formatted_ceph_monitor_ips() + + # Get tier info. + tiers = self.dbapi.storage_tier_get_list() + + tiers_cfg = [] + for bk in ceph_bks: + # Get the tier associated to the Ceph backend. + tier = next((t for t in tiers if t.forbackendid == bk.id), None) + if not tier: + raise Exception("No tier present for backend %s" % bk.name) + + # Get the tier rule name. + rule_name = "{0}{1}{2}".format( + tier.name, + constants.CEPH_CRUSH_TIER_SUFFIX, + "-ruleset").replace('-', '_') + + # Tier config needed for the overrides. + tier_cfg = { + "name": bk.name.encode('utf8', 'strict'), + "replication": int(bk.capabilities.get("replication")), + "min_replication": int(bk.capabilities.get("min_replication")), + "crush_rule_name": rule_name.encode('utf8', 'strict'), + } + tiers_cfg.append(tier_cfg) + + overrides = { + common.HELM_NS_RBD_PROVISIONER: { + 'conf': { + 'ceph': { + 'monitors': monitors, + 'storage_tiers': tiers_cfg + } + } + } + } + + if namespace in self.SUPPORTED_NAMESPACES: + return overrides[namespace] + elif namespace: + raise exception.InvalidHelmNamespace(chart=self.CHART, + namespace=namespace) + else: + return overrides diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/helm_toolkit.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/helm_toolkit.py new file mode 100644 index 0000000..133c11a --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/helm_toolkit.py @@ -0,0 +1,36 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +from k8sapp_platform.common import constants as app_constants + +from sysinv.common import exception +from sysinv.helm import common +from sysinv.helm import base + + +class HelmToolkitHelm(base.BaseHelm): + """Class to encapsulate helm operations for the helm toolkit""" + + CHART = app_constants.HELM_CHART_HELM_TOOLKIT + SUPPORTED_NAMESPACES = [ + common.HELM_NS_HELM_TOOLKIT, + ] + + def get_namespaces(self): + return self.SUPPORTED_NAMESPACES + + def get_overrides(self, namespace=None): + overrides = { + common.HELM_NS_HELM_TOOLKIT: {} + } + + if namespace in self.SUPPORTED_NAMESPACES: + return overrides[namespace] + elif namespace: + raise exception.InvalidHelmNamespace(chart=self.CHART, + namespace=namespace) + else: + return overrides diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/rbd_provisioner.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/rbd_provisioner.py new file mode 100644 index 0000000..d7cf12a --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/helm/rbd_provisioner.py @@ -0,0 +1,104 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +from k8sapp_platform.common import constants as app_constants + +from sysinv.common import constants +from sysinv.common import exception +from sysinv.common.storage_backend_conf import K8RbdProvisioner + +from sysinv.helm import base +from sysinv.helm import common + + +class RbdProvisionerHelm(base.BaseHelm): + """Class to encapsulate helm operations for the rbd-provisioner chart""" + + CHART = app_constants.HELM_CHART_RBD_PROVISIONER + SUPPORTED_NAMESPACES = base.BaseHelm.SUPPORTED_NAMESPACES + \ + [common.HELM_NS_RBD_PROVISIONER] + SUPPORTED_APP_NAMESPACES = { + constants.HELM_APP_PLATFORM: + base.BaseHelm.SUPPORTED_NAMESPACES + [common.HELM_NS_RBD_PROVISIONER], + } + + SERVICE_NAME = app_constants.HELM_CHART_RBD_PROVISIONER + SERVICE_PORT_MON = 6789 + + def execute_manifest_updates(self, operator): + # On application load this chart is enabled. Only disable if specified + # by the user + if not self._is_enabled(operator.APP, self.CHART, + common.HELM_NS_RBD_PROVISIONER): + operator.chart_group_chart_delete( + operator.CHART_GROUPS_LUT[self.CHART], + operator.CHARTS_LUT[self.CHART]) + + def get_overrides(self, namespace=None): + + backends = self.dbapi.storage_backend_get_list() + ceph_bks = [bk for bk in backends if bk.backend == constants.SB_TYPE_CEPH] + + if not ceph_bks: + return {} # ceph is not configured + + def _skip_ceph_mon_2(name): + return name != constants.CEPH_MON_2 + + classdefaults = { + "monitors": self._get_formatted_ceph_monitor_ips( + name_filter=_skip_ceph_mon_2), + "adminId": constants.K8S_RBD_PROV_USER_NAME, + "adminSecretName": constants.K8S_RBD_PROV_ADMIN_SECRET_NAME + } + + # Get tier info. + tiers = self.dbapi.storage_tier_get_list() + + classes = [] + for bk in ceph_bks: + # Get the ruleset for the new kube-rbd pool. + tier = next((t for t in tiers if t.forbackendid == bk.id), None) + if not tier: + raise Exception("No tier present for backend %s" % bk.name) + + rule_name = "{0}{1}{2}".format( + tier.name, + constants.CEPH_CRUSH_TIER_SUFFIX, + "-ruleset").replace('-', '_') + + cls = { + "name": K8RbdProvisioner.get_storage_class_name(bk), + "pool_name": K8RbdProvisioner.get_pool(bk), + "replication": int(bk.capabilities.get("replication")), + "crush_rule_name": rule_name, + "chunk_size": 64, + "userId": K8RbdProvisioner.get_user_id(bk), + "userSecretName": K8RbdProvisioner.get_user_secret_name(bk), + "additionalNamespaces": ['default', 'kube-public'], + } + classes.append(cls) + + global_settings = { + "replicas": self._num_provisioned_controllers(), + "defaultStorageClass": constants.K8S_RBD_PROV_STOR_CLASS_NAME + } + + overrides = { + common.HELM_NS_RBD_PROVISIONER: { + "classdefaults": classdefaults, + "classes": classes, + "global": global_settings + } + } + + if namespace in self.SUPPORTED_NAMESPACES: + return overrides[namespace] + elif namespace: + raise exception.InvalidHelmNamespace(chart=self.CHART, + namespace=namespace) + else: + return overrides diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/__init__.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/__init__.py new file mode 100644 index 0000000..06cfada --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/__init__.py @@ -0,0 +1,5 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# diff --git a/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/test_plugins.py b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/test_plugins.py new file mode 100644 index 0000000..d96f670 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/k8sapp_platform/tests/test_plugins.py @@ -0,0 +1,40 @@ +# +# SPDX-License-Identifier: Apache-2.0 +# + +from sysinv.tests.db import base as dbbase +from sysinv.tests.helm.test_helm import HelmOperatorTestSuiteMixin +from sysinv.common import constants + + +class K8SAppPlatformAppMixin(object): + app_name = constants.HELM_APP_PLATFORM + path_name = app_name + '.tgz' + + def setUp(self): + super(K8SAppPlatformAppMixin, self).setUp() + + +# Test Configuration: +# - Controller +# - IPv6 +# - Ceph Storage +# - platform-integ-apps app +class K8SAppPlatformControllerTestCase(K8SAppPlatformAppMixin, + dbbase.BaseIPv6Mixin, + dbbase.BaseCephStorageBackendMixin, + HelmOperatorTestSuiteMixin, + dbbase.ControllerHostTestCase): + pass + + +# Test Configuration: +# - AIO +# - IPv4 +# - Ceph Storage +# - platform-integ-apps app +class K8SAppPlatformAIOTestCase(K8SAppPlatformAppMixin, + dbbase.BaseCephStorageBackendMixin, + HelmOperatorTestSuiteMixin, + dbbase.AIOSimplexHostTestCase): + pass diff --git a/python-k8sapp-platform/k8sapp_platform/pylint.rc b/python-k8sapp-platform/k8sapp_platform/pylint.rc new file mode 100755 index 0000000..8293408 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/pylint.rc @@ -0,0 +1,287 @@ +[MASTER] +# Specify a configuration file. +rcfile=pylint.rc + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Add files or directories to the blacklist. Should be base names, not paths. +ignore=tests + +# Pickle collected data for later comparisons. +persistent=yes + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Use multiple processes to speed up Pylint. +jobs=4 + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist=lxml.etree,greenlet + + + +[MESSAGES CONTROL] +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time. +#enable= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). +# See "Messages Control" section of +# https://pylint.readthedocs.io/en/latest/user_guide +# We are disabling (C)onvention +# We are disabling (R)efactor +# We are selectively disabling (W)arning +# We are not disabling (F)atal, (E)rror +# The following warnings should be fixed: +# fixme (todo, xxx, fixme) +# W0101: unreachable +# W0105: pointless-string-statement +# W0106: expression-not-assigned +# W0107: unnecessary-pass +# W0108: unnecessary-lambda +# W0110: deprecated-lambda +# W0123: eval-used +# W0150: lost-exception +# W0201: attribute-defined-outside-init +# W0211: bad-staticmethod-argument +# W0212: protected-access +# W0221: arguments-differ +# W0223: abstract-method +# W0231: super-init-not-called +# W0235: useless-super-delegation +# W0311: bad-indentation +# W0402: deprecated-module +# W0403: relative-import +# W0404: reimported +# W0603: global-statement +# W0612: unused-variable +# W0613: unused-argument +# W0621: redefined-outer-name +# W0622: redefined-builtin +# W0631: undefined-loop-variable +# W0632: unbalanced-tuple-unpacking +# W0701: bad-except-order +# W0703: broad-except +# W1113: keyword-arg-before-vararg +# W1201: logging-not-lazy +# W1401: anomalous-backslash-in-string +# W1505: deprecated-method +# All these errors should be fixed: +# E0213: no-self-argument +# E0401: import-error +# E0604: invalid-all-object +# E0633: unpacking-non-sequence +# E0701: bad-except-order +# E1102: not-callable +# E1120: no-value-for-parameter +# E1121: too-many-function-args +disable=C, R, fixme, W0101, W0105, W0106, W0107, W0108, W0110, W0123, W0150, + W0201, W0211, W0212, W0221, W0223, W0231, W0235, W0311, W0402, W0403, + W0404, W0603, W0612, W0613, W0621, W0622, W0631, W0632, W0701, W0703, + W1113, W1201, W1401, W1505, + E0213, E0401, E0604, E0633, E0701, E1102, E1120, E1121 + +[REPORTS] +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html +output-format=text + +# Put messages in a separate file for each module / package specified on the +# command line instead of printing them on stdout. Reports (if any) will be +# written in a file name "pylint_global.[txt|html]". +files-output=no + +# Tells whether to display a full report or only the messages +reports=yes + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + + +[SIMILARITIES] +# Minimum lines number of a similarity. +min-similarity-lines=4 + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + + +[FORMAT] +# Maximum number of characters on a single line. +max-line-length=85 + +# Maximum number of lines in a module +max-module-lines=1000 + +# String used as indentation unit. This is usually 4 spaces or "\t" (1 tab). +indent-string=' ' + + +[TYPECHECK] +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis +ignored-modules=distutils,eventlet.green.subprocess,six,six.moves + +# List of classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +# pylint is confused by sqlalchemy Table, as well as sqlalchemy Enum types +# ie: (unprovisioned, identity) +# LookupDict in requests library confuses pylint +ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local, + Table, unprovisioned, identity, LookupDict + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E0201 when accessed. Python regular +# expressions are accepted. +generated-members=REQUEST,acl_users,aq_parent + + +[BASIC] +# List of builtins function names that should not be used, separated by a comma +bad-functions=map,filter,apply,input + +# Regular expression which should only match correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression which should only match correct module level names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression which should only match correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression which should only match correct function names +function-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct method names +method-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct instance attribute names +attr-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct argument names +argument-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct variable names +variable-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct list comprehension / +# generator expression variable names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Regular expression which should only match functions or classes name which do +# not require a docstring +no-docstring-rgx=__.*__ + + +[MISCELLANEOUS] +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX,TODO + + +[VARIABLES] +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the beginning of the name of dummy variables +# (i.e. not used). +dummy-variables-rgx=_|dummy + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + + +[IMPORTS] +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,string,TERMIOS,Bastion,rexec + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + + +[DESIGN] +# Maximum number of arguments for function / method +max-args=5 + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.* + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of branch for function / method body +max-branchs=12 + +# Maximum number of statements in function / method body +max-statements=50 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + + +[CLASSES] +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + + +[EXCEPTIONS] +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/python-k8sapp-platform/k8sapp_platform/requirements.txt b/python-k8sapp-platform/k8sapp_platform/requirements.txt new file mode 100644 index 0000000..5de6e00 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/requirements.txt @@ -0,0 +1,3 @@ +pbr>=2.0.0 +PyYAML>=3.10 + diff --git a/python-k8sapp-platform/k8sapp_platform/setup.cfg b/python-k8sapp-platform/k8sapp_platform/setup.cfg new file mode 100644 index 0000000..29ed9de --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/setup.cfg @@ -0,0 +1,44 @@ +[metadata] +name = k8sapp-platform +summary = StarlingX sysinv extensions for platform-integ-apps +long_description = file: README.rst +long_description_content_type = text/x-rst +license = Apache 2.0 +author = StarlingX +author-email = starlingx-discuss@lists.starlingx.io +home-page = https://www.starlingx.io/ +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 + +[files] +packages = + k8sapp_platform + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[entry_points] +systemconfig.helm_applications = + platform-integ-apps = systemconfig.helm_plugins.platform_integ_apps + +systemconfig.helm_plugins.platform_integ_apps = + 001_helm-toolkit = k8sapp_platform.helm.helm_toolkit:HelmToolkitHelm + 002_rbd-provisioner = k8sapp_platform.helm.rbd_provisioner:RbdProvisionerHelm + 003_ceph-pools-audit = k8sapp_platform.helm.ceph_pools_audit:CephPoolsAuditHelm + +systemconfig.armada.manifest_ops = + platform-integ-apps = k8sapp_platform.armada.manifest_platform:PlatformArmadaManifestOperator + +[wheel] +universal = 1 diff --git a/python-k8sapp-platform/k8sapp_platform/setup.py b/python-k8sapp-platform/k8sapp_platform/setup.py new file mode 100644 index 0000000..e8729b8 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/setup.py @@ -0,0 +1,12 @@ +# +# Copyright (c) 2020 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +import setuptools + + +setuptools.setup( + setup_requires=['pbr>=2.0.0'], + pbr=True) diff --git a/python-k8sapp-platform/k8sapp_platform/test-requirements.txt b/python-k8sapp-platform/k8sapp_platform/test-requirements.txt new file mode 100644 index 0000000..65209c8 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/test-requirements.txt @@ -0,0 +1,28 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +flake8<3.8.0 +pycodestyle<2.6.0 # MIT License +hacking>=1.1.0,<=2.0.0 # Apache-2.0 +coverage>=3.6 +discover +fixtures>=3.0.0 # Apache-2.0/BSD +mock>=2.0.0 # BSD +passlib>=1.7.0 +psycopg2-binary +python-barbicanclient<3.1.0,>=3.0.1 +python-subunit>=0.0.18 +requests-mock>=0.6.0 # Apache-2.0 +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 +oslosphinx<2.6.0,>=2.5.0 # Apache-2.0 +oslotest>=3.2.0 # Apache-2.0 +stestr>=1.0.0 # Apache-2.0 +testrepository>=0.0.18 +testtools!=1.2.0,>=0.9.36 +tempest-lib<0.5.0,>=0.4.0 +ipaddr +pytest +pyudev +migrate +python-ldap>=3.1.0 +markupsafe diff --git a/python-k8sapp-platform/k8sapp_platform/tox.ini b/python-k8sapp-platform/k8sapp_platform/tox.ini new file mode 100644 index 0000000..1f8e947 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/tox.ini @@ -0,0 +1,200 @@ +[tox] +envlist = flake8,py27,py36,pylint +minversion = 1.6 +# skipsdist = True +#,pip-missing-reqs + +# tox does not work if the path to the workdir is too long, so move it to /tmp +toxworkdir = /tmp/{env:USER}_k8splatformtox +stxdir = {toxinidir}/../../.. +distshare={toxworkdir}/.tox/distshare + +[testenv] +# usedevelop = True +# enabling usedevelop results in py27 develop-inst: +# Exception: Versioning for this project requires either an sdist tarball, +# or access to an upstream git repository. +# Note. site-packages is true and rpm-python must be yum installed on your dev machine. +sitepackages = True + +# tox is silly... these need to be separated by a newline.... +whitelist_externals = bash + find + +install_command = pip install \ + -v -v -v \ + -c{toxinidir}/upper-constraints.txt \ + -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/stable/stein/upper-constraints.txt} \ + {opts} {packages} + +# Note the hash seed is set to 0 until can be tested with a +# random hash seed successfully. +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + PYTHONDONTWRITEBYTECODE=1 + OS_TEST_PATH=./k8sapp_platform/tests + LANG=en_US.UTF-8 + LANGUAGE=en_US:en + LC_ALL=C + EVENTS_YAML=./k8sapp_platform/tests/events_for_testing.yaml + SYSINV_TEST_ENV=True + TOX_WORK_DIR={toxworkdir} + PYLINTHOME={toxworkdir} + +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + -e{[tox]stxdir}/config/controllerconfig/controllerconfig + -e{[tox]stxdir}/config/sysinv/sysinv/sysinv + -e{[tox]stxdir}/config/tsconfig/tsconfig + -e{[tox]stxdir}/fault/fm-api + -e{[tox]stxdir}/fault/python-fmclient/fmclient + -e{[tox]stxdir}/update/cgcs-patch/cgcs-patch + -e{[tox]stxdir}/utilities/ceph/python-cephclient/python-cephclient + +commands = + find . -type f -name "*.pyc" -delete + +[flake8] +# H series are hacking +# H101 is TODO +# H102 is apache license +# H104 file contains only comments (ie: license) +# H105 author tags +# H306 imports not in alphabetical order +# H401 docstring should not start with a space +# H403 multi line docstrings should end on a new line +# H404 multi line docstring should start without a leading new line +# H405 multi line docstring summary not separated with an empty line +# H701 Empty localization string +# H702 Formatting operation should be outside of localization method call +# H703 Multiple positional placeholders + +# B series are bugbear +# B006 Do not use mutable data structures for argument defaults. Needs to be FIXED. +# B007 Loop control variable not used within the loop body. +# B009 Do not call getattr with a constant attribute value +# B010 Do not call setattr with a constant attribute value +# B012 return/continue/break inside finally blocks cause exceptions to be silenced +# B014 Redundant exception types +# B301 Python 3 does not include `.iter*` methods on dictionaries. (this should be suppressed on a per line basis) +# B306 `BaseException.message` has been deprecated. Needs to be FIXED + +# W series are warnings +# W503 line break before binary operator +# W504 line break after binary operator +# W605 invalid escape sequence + +# E series are pep8 +# E117 over-indented +# E126 continuation line over-indented for hanging indent +# E127 continuation line over-indented for visual indent +# E128 continuation line under-indented for visual indent +# E402 module level import not at top of file + +ignore = H101,H102,H104,H105,H306,H401,H403,H404,H405,H701,H702,H703, + B006,B007,B009,B010,B012,B014,B301,B306, + W503,W504,W605, + E117,E126,E127,E128,E402 +exclude = build,dist,tools,.eggs +max-line-length=120 + +[testenv:flake8] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt + flake8-bugbear +commands = + flake8 {posargs} . + +[testenv:py27] +basepython = python2.7 +commands = + {[testenv]commands} + stestr run {posargs} + stestr slowest + +[testenv:py36] +basepython = python3.6 +commands = + {[testenv]commands} + stestr run {posargs} + stestr slowest + +[testenv:pep8] +# testenv:flake8 clone +basepython = {[testenv:flake8]basepython} +deps = {[testenv:flake8]deps} +commands = {[testenv:flake8]commands} + +[testenv:venv] +commands = {posargs} + +[bandit] +# The following bandit tests are being skipped: +# B101: Test for use of assert +# B103: Test for setting permissive file permissions +# B104: Test for binding to all interfaces +# B105: Test for use of hard-coded password strings +# B108: Test for insecure usage of tmp file/directory +# B110: Try, Except, Pass detected. +# B303: Use of insecure MD2, MD4, MD5, or SHA1 hash function. +# B307: Blacklisted call to eval. +# B310: Audit url open for permitted schemes +# B311: Standard pseudo-random generators are not suitable for security/cryptographic purposes +# B314: Blacklisted calls to xml.etree.ElementTree +# B318: Blacklisted calls to xml.dom.minidom +# B320: Blacklisted calls to lxml.etree +# B404: Import of subprocess module +# B405: import xml.etree +# B408: import xml.minidom +# B410: import lxml +# B506: Test for use of yaml load +# B602: Test for use of popen with shell equals true +# B603: Test for use of subprocess without shell equals true +# B604: Test for any function with shell equals true +# B605: Test for starting a process with a shell +# B607: Test for starting a process with a partial path +# +# Note: 'skips' entry cannot be split across multiple lines +# +skips = B101,B103,B104,B105,B108,B110,B303,B307,B310,B311,B314,B318,B320,B404,B405,B408,B410,B506,B602,B603,B604,B605,B607 +exclude = tests + +[testenv:bandit] +basepython = python3 +deps = -r{toxinidir}/test-requirements.txt + bandit + +commands = bandit --ini tox.ini -n 5 -r k8sapp_platform + +[testenv:pylint] +basepython = python2.7 +sitepackages = False + +deps = {[testenv]deps} + pylint +commands = + pylint {posargs} k8sapp_platform --rcfile=./pylint.rc + +[testenv:cover] +basepython = python2.7 +deps = {[testenv]deps} +setenv = {[testenv]setenv} + PYTHON=coverage run --parallel-mode + +commands = + {[testenv]commands} + coverage erase + stestr run {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml + coverage report + +[testenv:pip-missing-reqs] +# do not install test-requirements as that will pollute the virtualenv for +# determining missing packages +# this also means that pip-missing-reqs must be installed separately, outside +# of the requirements.txt files +deps = pip_missing_reqs + -rrequirements.txt +commands=pip-missing-reqs -d --ignore-file=/k8sapp_platform/tests k8sapp_platform diff --git a/python-k8sapp-platform/k8sapp_platform/upper-constraints.txt b/python-k8sapp-platform/k8sapp_platform/upper-constraints.txt new file mode 100644 index 0000000..9c30188 --- /dev/null +++ b/python-k8sapp-platform/k8sapp_platform/upper-constraints.txt @@ -0,0 +1 @@ +# Override upstream constraints based on StarlingX load diff --git a/stx-platform-helm/centos/build_srpm.data b/stx-platform-helm/centos/build_srpm.data index ccb02be..fc61c75 100644 --- a/stx-platform-helm/centos/build_srpm.data +++ b/stx-platform-helm/centos/build_srpm.data @@ -4,4 +4,10 @@ COPY_LIST_TO_TAR="\ $STX_BASE/helm-charts/node-feature-discovery/node-feature-discovery/helm-charts \ " -TIS_PATCH_VER=8 +# Bump The version to be one less that what the version was prior to decoupling +# as this will align the GITREVCOUNT value to increment the version by one. +# Remove this (i.e. reset to 0) on then next major version changes when +# TIS_BASE_SRCREV changes. This version should align with the version of the +# plugins in python-k8sapp-platform +TIS_BASE_SRCREV=c608f2aaa92064b712e7076e4141a162b78fe995 +TIS_PATCH_VER=GITREVCOUNT+7 diff --git a/stx-platform-helm/centos/stx-platform-helm.spec b/stx-platform-helm/centos/stx-platform-helm.spec index 1774a3d..a335383 100644 --- a/stx-platform-helm/centos/stx-platform-helm.spec +++ b/stx-platform-helm/centos/stx-platform-helm.spec @@ -9,7 +9,7 @@ %global helm_folder /usr/lib/helm %global toolkit_version 0.1.0 -Summary: StarlingX Platform Helm charts +Summary: StarlingX K8S application: Platform Integration Name: stx-platform-helm Version: 1.0 Release: %{tis_patch_ver}%{?_tis_dist} @@ -24,9 +24,11 @@ BuildArch: noarch BuildRequires: helm BuildRequires: openstack-helm-infra +BuildRequires: python-k8sapp-platform +BuildRequires: python-k8sapp-platform-wheels %description -StarlingX Platform Helm charts +The StarlingX K8S application for platform integration %prep %setup @@ -63,7 +65,8 @@ helm repo add local http://localhost:8879/charts cd helm-charts make rbd-provisioner make ceph-pools-audit -make node-feature-discovery +# TODO (rchurch): remove +make node-feature-discovery cd - # Terminate helm server (the last backgrounded task) @@ -86,6 +89,10 @@ sed -i 's/@APP_NAME@/%{app_name}/g' %{app_staging}/metadata.yaml sed -i 's/@APP_VERSION@/%{version}-%{tis_patch_ver}/g' %{app_staging}/metadata.yaml sed -i 's/@HELM_REPO@/%{helm_repo}/g' %{app_staging}/metadata.yaml +# Copy the plugins: installed in the buildroot +mkdir -p %{app_staging}/plugins +cp /plugins/*.whl %{app_staging}/plugins + # package it up find . -type f ! -name '*.md5' -print0 | xargs -0 md5sum > checksum.md5 tar -zcf %{_builddir}/%{app_tarball} -C %{app_staging}/ . @@ -97,6 +104,7 @@ rm -fr %{app_staging} install -d -m 755 %{buildroot}/%{app_folder} install -p -D -m 755 %{_builddir}/%{app_tarball} %{buildroot}/%{app_folder} install -d -m 755 ${RPM_BUILD_ROOT}/opt/extracharts +# TODO (rchurch): remove install -p -D -m 755 helm-charts/node-feature-discovery-*.tgz ${RPM_BUILD_ROOT}/opt/extracharts %files