airshipctl/tools/validate_docs
Ruslan Aliev 3e44c42989 Introduce KRM based k8s applier
The KRM based k8s applier solves multiple design problems
which were introduced in previous airshipctl generation,
making apply code and process more clear, reliable and
readable. In particular:
 * k8s applier now is a KRM function and it allows the
   end user to choose or implement desired backend for
   k8s apply operations;
 * the related amount of code was reduced by three times,
   multiple unused and unnecessary structs/interfaces/design
   patterns were removed or rewrited in more clean and efficient
   way;
 * removed cli-utils dependency from airshipctl;
 * fixed several bugs and code issues, such as incorrect printing
   of tables, duplicated unit tests, improper generation and applying
   inventory config map, etc;
 * cli-utils version used in KRM function was bumped to 0.26.0;
 * phases with duplicated k8s resources were removed or fixed;
 * unit test coverage increased to 83.1%;
 * KRM function logs were integrated with klog library which allows
   to observe logs directly from cli-utils and other dependent libs.

Change-Id: Ief509f1d6abefd53caf7fcffc4e36b0319815373
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
Closes: #646
2021-10-27 08:14:22 +00:00

82 lines
2.7 KiB
Bash
Executable File

#!/usr/bin/env bash
# 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.
# The makefile entrypoint driver for document validation
# Expected to be run from the project root
set -xe
set -o pipefail
# The root of the manifest structure to be validated.
# This corresponds to the targetPath in an airshipctl config
: ${MANIFEST_ROOT:="$(dirname "${PWD}")"}
# The space-separated locations of sites whose manifests should be validated.
# These are relative to MANIFEST_ROOT above
: ${MANIFEST_PATH:="manifests/site"}
: ${SITE_ROOTS:="$(basename "${PWD}")/${MANIFEST_PATH}"}
: ${MANIFEST_REPO_URL:="https://review.opendev.org/airship/airshipctl"}
: ${SITES_TO_SKIP:="az-test-site gcp-test-site openstack-test-site"}
# Name of specific site to be validated
SITE=$1
TMP=$(mktemp -d)
# TODO: use `airshipctl config` to do this once all the needed knobs are exposed
function generate_airshipconf() {
cat <<EOL >"${TMP}/$1.cfg"
apiVersion: airshipit.org/v1alpha1
contexts:
default_context:
manifest: default_manifest
managementConfiguration: default_mgmt_config
currentContext: default_context
kind: Config
managementConfiguration:
default_mgmt_config:
insecure: true
systemActionRetries: 30
systemRebootDelay: 30
type: redfish
manifests:
default_manifest:
phaseRepositoryName: primary
repositories:
primary:
checkout:
branch: master
commitHash: ""
force: false
tag: ""
url: ${MANIFEST_REPO_URL}
targetPath: ${MANIFEST_ROOT}
metadataPath: ${MANIFEST_PATH}/$1/metadata.yaml
EOL
}
for site_root in ${SITE_ROOTS}; do
for site in $(ls ${MANIFEST_ROOT}/${site_root}); do
sites_to_skip=(${SITES_TO_SKIP})
if [[ -z "$SITE" && " ${sites_to_skip[@]} " =~ " ${site} " ]] || [[ ! -z "$SITE" && "$site" != $SITE ]]; then
continue
fi
echo -e "\nValidating site: ${MANIFEST_ROOT}/${site_root}/${site}\n****************"
generate_airshipconf $site
phase_plans=$(airshipctl --airshipconf "${TMP}/$site.cfg" plan list | tail -n +2 | awk '{print $1}')
for plan in $phase_plans; do
airshipctl --airshipconf "${TMP}/$site.cfg" plan validate $plan
done
echo "Validation of site ${site} is successful!"
done
done