From 8d553f7e91705280b445893ecdeb7f92774a3927 Mon Sep 17 00:00:00 2001
From: Cristian Calin <6627509+cristicalin@users.noreply.github.com>
Date: Fri, 5 Nov 2021 09:57:52 +0200
Subject: [PATCH] Mitogen: deprecate the use of mitogen and remove coverage
from CI (#8147)
---
.gitlab-ci/packet.yml | 11 -----------
.gitlab-ci/terraform.yml | 4 ----
Makefile | 4 +++-
ansible.cfg | 1 -
docs/ansible.md | 2 +-
docs/mitogen.md | 17 +++++++++++++++++
tests/scripts/testcases_run.sh | 7 -------
7 files changed, 21 insertions(+), 25 deletions(-)
diff --git a/.gitlab-ci/packet.yml b/.gitlab-ci/packet.yml
index 30d6ba3f3..9b432a19a 100644
--- a/.gitlab-ci/packet.yml
+++ b/.gitlab-ci/packet.yml
@@ -39,8 +39,6 @@ packet_centos7-flannel-containerd-addons-ha:
extends: .packet_pr
stage: deploy-part2
when: on_success
- variables:
- MITOGEN_ENABLE: "true"
allow_failure: true
packet_centos8-crio:
@@ -52,8 +50,6 @@ packet_ubuntu18-crio:
extends: .packet_pr
stage: deploy-part2
when: manual
- variables:
- MITOGEN_ENABLE: "true"
packet_ubuntu16-canal-kubeadm-ha:
stage: deploy-part2
@@ -89,8 +85,6 @@ packet_debian10-containerd:
stage: deploy-part2
extends: .packet_pr
when: on_success
- variables:
- MITOGEN_ENABLE: "true"
packet_debian11-calico:
stage: deploy-part2
@@ -214,15 +208,12 @@ packet_centos7-weave-upgrade-ha:
when: on_success
variables:
UPGRADE_TEST: basic
- MITOGEN_ENABLE: "false"
# Calico HA Wireguard
packet_ubuntu20-calico-ha-wireguard:
stage: deploy-part2
extends: .packet_pr
when: manual
- variables:
- MITOGEN_ENABLE: "true"
packet_debian9-calico-upgrade:
stage: deploy-part3
@@ -230,7 +221,6 @@ packet_debian9-calico-upgrade:
when: on_success
variables:
UPGRADE_TEST: graceful
- MITOGEN_ENABLE: "false"
packet_debian9-calico-upgrade-once:
stage: deploy-part3
@@ -238,7 +228,6 @@ packet_debian9-calico-upgrade-once:
when: on_success
variables:
UPGRADE_TEST: graceful
- MITOGEN_ENABLE: "false"
packet_ubuntu18-calico-ha-recover:
stage: deploy-part3
diff --git a/.gitlab-ci/terraform.yml b/.gitlab-ci/terraform.yml
index d12ca3815..91874091f 100644
--- a/.gitlab-ci/terraform.yml
+++ b/.gitlab-ci/terraform.yml
@@ -146,10 +146,6 @@ tf-validate-upcloud:
OS_INTERFACE: public
OS_IDENTITY_API_VERSION: "3"
TF_VAR_router_id: "ab95917c-41fb-4881-b507-3a6dfe9403df"
- # Since ELASTX is in Stockholm, Mitogen helps with latency
- MITOGEN_ENABLE: "false"
- # Mitogen doesn't support interpreter discovery yet
- ANSIBLE_PYTHON_INTERPRETER: "/usr/bin/python3"
tf-elastx_cleanup:
stage: unit-tests
diff --git a/Makefile b/Makefile
index 2093b820b..793e763dc 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,7 @@
mitogen:
- ansible-playbook -c local mitogen.yml -vv
+ @echo Mitogen support is deprecated.
+ @echo Please run the following command manually:
+ @echo ansible-playbook -c local mitogen.yml -vv
clean:
rm -rf dist/
rm *.retry
diff --git a/ansible.cfg b/ansible.cfg
index 213206498..c17fe48fd 100644
--- a/ansible.cfg
+++ b/ansible.cfg
@@ -3,7 +3,6 @@ pipelining=True
ssh_args = -o ControlMaster=auto -o ControlPersist=30m -o ConnectionAttempts=100 -o UserKnownHostsFile=/dev/null
#control_path = ~/.ssh/ansible-%%r@%%h:%%p
[defaults]
-strategy_plugins = plugins/mitogen/ansible_mitogen/plugins/strategy
# https://github.com/ansible/ansible/issues/56930 (to ignore group names with - and .)
force_valid_group_names = ignore
diff --git a/docs/ansible.md b/docs/ansible.md
index 044397f9f..cc51d2617 100644
--- a/docs/ansible.md
+++ b/docs/ansible.md
@@ -251,7 +251,7 @@ For more information about Ansible and bastion hosts, read
## Mitogen
-You can use [mitogen](/docs/mitogen.md) to speed up kubespray.
+Mitogen support is deprecated, please see [mitogen related docs](/docs/mitogen.md) for useage and reasons for deprecation.
## Beyond ansible 2.9
diff --git a/docs/mitogen.md b/docs/mitogen.md
index 89b108a6c..8505845fb 100644
--- a/docs/mitogen.md
+++ b/docs/mitogen.md
@@ -1,5 +1,7 @@
# Mitogen
+*Warning:* Mitogen support is now deprecated in kubespray due to upstream not releasing an updated version to support ansible 4.x (ansible-base 2.11.x) and above. The CI support has been stripped for mitogen and we are no longer validating any support or regressions for it. The supporting mitogen install playbook and integration documentation will be removed in a later version.
+
[Mitogen for Ansible](https://mitogen.networkgenomics.com/ansible_detailed.html) allow a 1.25x - 7x speedup and a CPU usage reduction of at least 2x, depending on network conditions, modules executed, and time already spent by targets on useful work. Mitogen cannot improve a module once it is executing, it can only ensure the module executes as quickly as possible.
## Install
@@ -8,6 +10,21 @@
ansible-playbook mitogen.yml
```
+Ensure to enable mitogen use by environment varialbles:
+
+```ShellSession
+export ANSIBLE_STRATEGY=mitogen_linear
+export ANSIBLE_STRATEGY_PLUGINS=plugins/mitogen/ansible_mitogen/plugins/strategy
+```
+
+... or `ansible.cfg` setup:
+
+```ini
+[defaults]
+strategy_plugins = plugins/mitogen/ansible_mitogen/plugins/strategy
+strategy=mitogen_linear
+```
+
## Limitation
If you are experiencing problems, please see the [documentation](https://mitogen.networkgenomics.com/ansible_detailed.html#noteworthy-differences).
diff --git a/tests/scripts/testcases_run.sh b/tests/scripts/testcases_run.sh
index 55cf7c3c7..2461d29c6 100755
--- a/tests/scripts/testcases_run.sh
+++ b/tests/scripts/testcases_run.sh
@@ -50,13 +50,6 @@ test "${UPGRADE_TEST}" != "false" && git fetch --all && git checkout "$KUBESPRAY
test "${UPGRADE_TEST}" != "false" && git checkout "${CI_BUILD_REF}" tests/files/${CI_JOB_NAME}.yml
test "${UPGRADE_TEST}" != "false" && git checkout "${CI_BUILD_REF}" ${CI_TEST_REGISTRY_MIRROR}
-# Install mitogen ansible plugin
-if [ "${MITOGEN_ENABLE}" = "true" ]; then
- ansible-playbook ${ANSIBLE_LOG_LEVEL} mitogen.yml
- export ANSIBLE_STRATEGY=mitogen_linear
- export ANSIBLE_STRATEGY_PLUGINS=plugins/mitogen/ansible_mitogen/plugins/strategy
-fi
-
# Create cluster
ansible-playbook ${ANSIBLE_LOG_LEVEL} -e @${CI_TEST_REGISTRY_MIRROR} -e @${CI_TEST_VARS} -e local_release_dir=${PWD}/downloads --limit "all:!fake_hosts" cluster.yml
--
GitLab