From 769412b461ff7fc6b4fb820572dd0d93b460b7ea Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 10:58:49 +0530 Subject: [PATCH 01/15] remove Gevent from syft --- docs/source/api_reference/syft.rst | 7 ----- packages/grid/backend/grid/start.sh | 1 - packages/syft/setup.cfg | 1 - packages/syft/src/syft/__init__.py | 1 - packages/syft/src/syft/gevent_patch.py | 37 -------------------------- 5 files changed, 47 deletions(-) delete mode 100644 packages/syft/src/syft/gevent_patch.py diff --git a/docs/source/api_reference/syft.rst b/docs/source/api_reference/syft.rst index f2bf2008e6c..d10b471583a 100644 --- a/docs/source/api_reference/syft.rst +++ b/docs/source/api_reference/syft.rst @@ -33,10 +33,3 @@ syft.abstract\_node module :undoc-members: :show-inheritance: -syft.gevent\_patch module -------------------------- - -.. automodule:: syft.gevent_patch - :members: - :undoc-members: - :show-inheritance: diff --git a/packages/grid/backend/grid/start.sh b/packages/grid/backend/grid/start.sh index 297f242ff78..bcb36c5e5a9 100755 --- a/packages/grid/backend/grid/start.sh +++ b/packages/grid/backend/grid/start.sh @@ -29,7 +29,6 @@ export CREDENTIALS_PATH=${CREDENTIALS_PATH:-$HOME/data/creds/credentials.json} export NODE_PRIVATE_KEY=$(python $APPDIR/grid/bootstrap.py --private_key) export NODE_UID=$(python $APPDIR/grid/bootstrap.py --uid) export NODE_TYPE=$NODE_TYPE -export GEVENT_MONKEYPATCH="False" echo "NODE_UID=$NODE_UID" echo "NODE_TYPE=$NODE_TYPE" diff --git a/packages/syft/setup.cfg b/packages/syft/setup.cfg index 81b0272d8a3..d75d3f9620f 100644 --- a/packages/syft/setup.cfg +++ b/packages/syft/setup.cfg @@ -30,7 +30,6 @@ syft = bcrypt==4.1.2 boto3==1.34.56 forbiddenfruit==0.1.4 - gevent==23.9.1 loguru==0.7.2 networkx==3.2.1 packaging>=23.0 diff --git a/packages/syft/src/syft/__init__.py b/packages/syft/src/syft/__init__.py index 3aae76848dc..b1da85397c3 100644 --- a/packages/syft/src/syft/__init__.py +++ b/packages/syft/src/syft/__init__.py @@ -9,7 +9,6 @@ from typing import Any # relative -from . import gevent_patch # noqa: F401 from .abstract_node import NodeSideType # noqa: F401 from .abstract_node import NodeType # noqa: F401 from .client.client import connect # noqa: F401 diff --git a/packages/syft/src/syft/gevent_patch.py b/packages/syft/src/syft/gevent_patch.py deleted file mode 100644 index c74b10a45b6..00000000000 --- a/packages/syft/src/syft/gevent_patch.py +++ /dev/null @@ -1,37 +0,0 @@ -# stdlib -import os - - -def str_to_bool(bool_str: str | None) -> bool: - result = False - bool_str = str(bool_str).lower() - if bool_str == "true" or bool_str == "1": - result = True - return result - - -GEVENT_MONKEYPATCH = str_to_bool(os.environ.get("GEVENT_MONKEYPATCH", "False")) - -# 🟑 TODO 30: Move this to where we manage the different concurrency modes later -# make sure its stable in containers and other run targets -# if GEVENT_MONKEYPATCH: -# monkey.patch_all(ssl=False) - - -def is_notebook() -> bool: - # third party - from IPython import get_ipython - - try: - shell = get_ipython().__class__.__name__ - if shell == "ZMQInteractiveShell": - return True # Jupyter notebook or qtconsole - elif shell == "TerminalInteractiveShell": - return False # Terminal running IPython - else: - return False # Other type (?) - except NameError: - return False # Probably standard Python interpreter - - -jupyter_notebook = is_notebook() From 7045e89d73e245b9e2ab856585b7ce706dde2d55 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 10:59:28 +0530 Subject: [PATCH 02/15] rename hagrid wordings in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 48e0a38c5cb..6a02379e67a 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ helm install ... --set ingress.class="gce" ## Note: -🚨 Our deployment tool `Hagrid` has been `Deprecated`. For the updated deployment options kindly refer to +🚨 Our old deployment tool `Hagrid` has been `Deprecated`. For the updated deployment options kindly refer to - πŸ“š Deployments From ce7c91bf6a01c62a7c4d3418f20cb607e111d759 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:03:38 +0530 Subject: [PATCH 03/15] Remove ansible --- .pre-commit-config.yaml | 8 +- packages/grid/Vagrantfile | 57 -------- packages/grid/ansible/group_vars/all/vars.yml | 26 ---- .../grid/ansible/roles/aa_demo/tasks/main.yml | 57 -------- .../roles/containers/handlers/main.yml | 6 - .../roles/containers/tasks/containers.yml | 56 -------- .../ansible/roles/containers/tasks/hagrid.yml | 21 --- .../ansible/roles/containers/tasks/main.yml | 5 - .../ansible/roles/containers/tasks/src.yml | 31 ---- .../ansible/roles/containers/tasks/tls.yml | 28 ---- .../grid/ansible/roles/jupyter/tasks/main.yml | 13 -- .../grid/ansible/roles/network/tasks/main.yml | 19 --- .../grid/ansible/roles/node/handlers/main.yml | 6 - .../grid/ansible/roles/node/tasks/docker.yml | 105 -------------- .../grid/ansible/roles/node/tasks/main.yml | 47 ------- .../ansible/roles/node/tasks/security.yml | 8 -- .../grid/ansible/roles/node/tasks/system.yml | 133 ------------------ .../grid/ansible/roles/update/tasks/main.yml | 37 ----- packages/grid/ansible/site.yml | 12 -- tox.ini | 1 - 20 files changed, 4 insertions(+), 672 deletions(-) delete mode 100644 packages/grid/Vagrantfile delete mode 100755 packages/grid/ansible/group_vars/all/vars.yml delete mode 100644 packages/grid/ansible/roles/aa_demo/tasks/main.yml delete mode 100755 packages/grid/ansible/roles/containers/handlers/main.yml delete mode 100755 packages/grid/ansible/roles/containers/tasks/containers.yml delete mode 100755 packages/grid/ansible/roles/containers/tasks/hagrid.yml delete mode 100755 packages/grid/ansible/roles/containers/tasks/main.yml delete mode 100644 packages/grid/ansible/roles/containers/tasks/src.yml delete mode 100644 packages/grid/ansible/roles/containers/tasks/tls.yml delete mode 100644 packages/grid/ansible/roles/jupyter/tasks/main.yml delete mode 100644 packages/grid/ansible/roles/network/tasks/main.yml delete mode 100755 packages/grid/ansible/roles/node/handlers/main.yml delete mode 100755 packages/grid/ansible/roles/node/tasks/docker.yml delete mode 100755 packages/grid/ansible/roles/node/tasks/main.yml delete mode 100644 packages/grid/ansible/roles/node/tasks/security.yml delete mode 100755 packages/grid/ansible/roles/node/tasks/system.yml delete mode 100644 packages/grid/ansible/roles/update/tasks/main.yml delete mode 100755 packages/grid/ansible/site.yml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2b4c5fa22ac..a9269f8f90b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,14 +3,14 @@ repos: rev: v4.5.0 hooks: - id: check-ast - exclude: ^(packages/grid/ansible/|packages/syft/tests/mongomock) + exclude: ^(packages/syft/tests/mongomock) always_run: true - id: trailing-whitespace always_run: true exclude: ^(docs/|.+\.md|.bumpversion.cfg|packages/syft/tests/mongomock) - id: check-docstring-first always_run: true - exclude: ^(packages/grid/ansible/|packages/syft/tests/mongomock) + exclude: ^(packages/syft/tests/mongomock) - id: check-json always_run: true exclude: ^(packages/grid/frontend/|packages/syft/tests/mongomock) @@ -25,10 +25,10 @@ repos: args: ["--assume-in-merge"] - id: check-executables-have-shebangs always_run: true - exclude: ^(packages/grid/ansible/|packages/syft/tests/mongomock) + exclude: ^(packages/syft/tests/mongomock) - id: debug-statements always_run: true - exclude: ^(packages/grid/ansible/|packages/syft/tests/mongomock) + exclude: ^(packages/syft/tests/mongomock) - id: name-tests-test always_run: true exclude: ^(.*/tests/utils/)|^(.*fixtures.py|packages/syft/tests/mongomock) diff --git a/packages/grid/Vagrantfile b/packages/grid/Vagrantfile deleted file mode 100644 index 04ab6f7a212..00000000000 --- a/packages/grid/Vagrantfile +++ /dev/null @@ -1,57 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : - -VAGRANTFILE_API_VERSION = "2" - -Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| - config.ssh.insert_key = true - config.vm.provision :ansible do |ansible| - ansible.extra_vars = { vagrant: true} - ansible.raw_arguments = Shellwords.shellsplit(ENV['ANSIBLE_ARGS']) if ENV['ANSIBLE_ARGS'] - ansible.compatibility_mode = "auto" - ansible.playbook = "./ansible/site.yml" - ansible.groups = { - "domain" => [ - "ubuntu", - ], - } - end - - config.vm.define "ubuntu-22-04-arm64" do |node| - node.vm.box = "bento/ubuntu-22.04-arm64" - - node.vm.box_check_update = false - - node.vm.hostname = "ubuntu-22-04-arm64.openmined.grid" - node.vm.network :private_network, ip: "192.168.56.2" - - node.vm.synced_folder "../../", "/home/om/PySyft", - mount_options: ["dmode=775,fmode=774"] - - node.vm.provider "parallels" do |vb, override| - vb.memory = "8096" - vb.cpus = "4" - vb.name = "ubuntu-22-04-arm64" - override.vm.synced_folder "../../", "/home/om/PySyft", owner: "vagrant", group: "vagrant", create: true, mount_options: [ "share" ] - end - end - - config.vm.define "ubuntu-22-04-x86" do |node| - node.vm.box = "bento/ubuntu-22.04" - - node.vm.box_check_update = false - - node.vm.hostname = "ubuntu-22-04-x86.openmined.grid" - node.vm.network :private_network, ip: "192.168.56.2" - - node.vm.synced_folder "../../", "/home/om/PySyft", - mount_options: ["dmode=775,fmode=774"] - - node.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.cpus = "2" - vb.name = "ubuntu-22-04-x86" - end - end - -end diff --git a/packages/grid/ansible/group_vars/all/vars.yml b/packages/grid/ansible/group_vars/all/vars.yml deleted file mode 100755 index bebf2f16bb9..00000000000 --- a/packages/grid/ansible/group_vars/all/vars.yml +++ /dev/null @@ -1,26 +0,0 @@ ---- -om_user: om -om_group: om -om_homedir: "/home/{{ om_user }}" -syft_dir: "/home/om/PySyft" -build_dir: "/home/om/build" -github_repo: OpenMined/PySyft.git -repo_branch: "dev" -docker_compose_plugin_dir: ".docker/cli-plugins" -node_name: node -node_type: domain -root_user: root -root_homedir: "/{{ root_user }}" -docker_compose_url_x86: https://github.com/docker/compose/releases/download/v2.17.1/docker-compose-linux-x86_64 -docker_compose_url_arm64: https://github.com/docker/compose/releases/download/v2.17.1/docker-compose-linux-aarch64 -tls: "false" -release: "production" -cert_store_path: "{{ om_homedir }}/certs" -upload_tls_key: "" -upload_tls_cert: "" -install: "true" -jupyter: "false" -docker_tag: "local" -node_side_type: "high" -root_user_email: "info@openmined.org" -root_user_password: "changethis" diff --git a/packages/grid/ansible/roles/aa_demo/tasks/main.yml b/packages/grid/ansible/roles/aa_demo/tasks/main.yml deleted file mode 100644 index 81b62321fe8..00000000000 --- a/packages/grid/ansible/roles/aa_demo/tasks/main.yml +++ /dev/null @@ -1,57 +0,0 @@ ---- -- name: Install System Packages - package: - name: "{{ item }}" - state: present - autoclean: yes - update_cache: yes - loop: - - python3-pip - when: aa_demo is defined and aa_demo == "true" - -- name: Install HAGrid - shell: "runuser -l {{ om_user }} -c 'pip install -U hagrid'" - become: yes - when: aa_demo is defined and aa_demo == "true" - -- name: Install Syft - shell: "runuser -l {{ om_user }} -c 'pip install -U syft'" - become: yes - when: aa_demo is defined and aa_demo == "true" - -- name: Create HAGrid PySyft src - file: - path: "{{ syft_dir }}/.tox/syft.jupyter/lib/python3.8/site-packages/hagrid" - state: directory - mode: "0775" - owner: "{{ om_user }}" - group: "{{ om_user }}" - when: aa_demo is defined and aa_demo == "true" - -- name: Clone PySyft Repo - git: - repo: "https://github.com/{{ github_repo }}" - dest: "{{ syft_dir }}/.tox/syft.jupyter/lib/python3.8/site-packages/hagrid/PySyft" - version: "{{ repo_branch }}" - force: yes - become_user: "{{ om_user }}" - ignore_errors: yes - when: aa_demo is defined and aa_demo == "true" - -- name: Kill Docker Containers - shell: "docker rm $(docker ps -qa) --force || true" - become: yes - ignore_errors: yes - when: aa_demo is defined and aa_demo == "true" - -- name: Start Docker Containers - shell: - cmd: runuser -l {{ om_user }} -c 'hagrid launch domain to docker:80 --tag=latest' - become: yes - when: aa_demo is defined and aa_demo == "true" - -- name: Kill Docker Containers - shell: "docker rm $(docker ps -qa) --force || true" - become: yes - ignore_errors: yes - when: aa_demo is defined and aa_demo == "true" diff --git a/packages/grid/ansible/roles/containers/handlers/main.yml b/packages/grid/ansible/roles/containers/handlers/main.yml deleted file mode 100755 index 2965b21f99b..00000000000 --- a/packages/grid/ansible/roles/containers/handlers/main.yml +++ /dev/null @@ -1,6 +0,0 @@ ---- -- name: restart docker - service: - name: docker - state: restarted - daemon_reload: yes diff --git a/packages/grid/ansible/roles/containers/tasks/containers.yml b/packages/grid/ansible/roles/containers/tasks/containers.yml deleted file mode 100755 index 123caea95b5..00000000000 --- a/packages/grid/ansible/roles/containers/tasks/containers.yml +++ /dev/null @@ -1,56 +0,0 @@ ---- -# - name: Build Docker Images -# shell: "docker compose build" -# args: -# chdir: "{{ build_dir }}/packages/grid" -# become_user: "{{ om_user }}" -# when: vagrant is not defined and install == "true" and docker_tag == "local" - -# - name: Build Docker Images -# shell: "docker compose build" -# args: -# chdir: "{{ syft_dir }}/packages/grid" -# become_user: "{{ om_user }}" -# when: vagrant is defined and install == "true" and docker_tag == "local" - -- name: Remove old Docker Images - shell: "docker rmi $(docker images -qa -f 'dangling=true') || true" - become_user: "{{ om_user }}" - ignore_errors: yes - when: install == "true" and docker_tag == "local" - -# - name: Remove Docker Volumes -# shell: "docker volume prune -f" -# become_user: "{{ om_user }}" -# ignore_errors: yes -# when: docker_volume_destroy is defined - -- name: Restart Docker Service - service: - name: docker - state: restarted - daemon_reload: yes - -- name: Start Docker Containers - shell: - cmd: runuser -l {{ om_user }} -c 'hagrid launch {{ node_name }} {{ node_type }} to docker:80 --release={{ release }} --tag={{ docker_tag }} --set-root-email={{ root_user_email }} --set-root-password={{ root_user_password }}' - become: yes - when: tls == "false" and install == "true" and node_side_type == "high" - -- name: Start Low Side Docker Containers - shell: - cmd: runuser -l {{ om_user }} -c 'hagrid launch {{ node_name }} {{ node_type }} to docker:80 --release={{ release }} --tag={{ docker_tag }} --low-side --set-root-email={{ root_user_email }} --set-root-password={{ root_user_password }}' - become: yes - when: tls == "false" and install == "true" and node_side_type == "low" - -- name: Start Docker Containers with TLS - shell: - cmd: runuser -l {{ om_user }} -c 'hagrid launch {{ node_name }} {{ node_type }} to docker:80 --release={{ release }} --tag={{ docker_tag }} --set-root-email={{ root_user_email }} --set-root-password={{ root_user_password }} --tls --cert-store-path={{ cert_store_path }}' - become: yes - when: tls == "true" and install == "true" and node_side_type == "high" - -- name: Start Low Docker Containers with TLS - shell: - cmd: runuser -l {{ om_user }} -c 'hagrid launch {{ node_name }} {{ node_type }} to docker:80 --release={{ release }} --tag={{ docker_tag }} --low-side --set-root-email={{ root_user_email }} --set-root-password={{ root_user_password }} --tls --cert-store-path={{ cert_store_path }}' - become: yes - when: tls == "true" and install == "true" and node_side_type == "low" diff --git a/packages/grid/ansible/roles/containers/tasks/hagrid.yml b/packages/grid/ansible/roles/containers/tasks/hagrid.yml deleted file mode 100755 index b715e9e6d96..00000000000 --- a/packages/grid/ansible/roles/containers/tasks/hagrid.yml +++ /dev/null @@ -1,21 +0,0 @@ ---- -- name: Add /home/{{ om_user }}/.local/bin to PATH in .profile - ansible.builtin.lineinfile: - create: true - path: "/home/{{ om_user }}/.profile" - line: 'export PATH="$HOME/.local/bin:$PATH"' - insertafter: EOF - state: present - become: yes - become_user: om - become_method: sudo - -- name: Install HAGrid - shell: "runuser -l {{ om_user }} -c 'pip install -e {{ build_dir }}/packages/hagrid'" - become: yes - when: vagrant is not defined and install == "true" - -- name: Install HAGrid - shell: "runuser -l {{ om_user }} -c 'pip install -e {{ syft_dir }}/packages/hagrid'" - become: yes - when: vagrant is defined and install == "true" diff --git a/packages/grid/ansible/roles/containers/tasks/main.yml b/packages/grid/ansible/roles/containers/tasks/main.yml deleted file mode 100755 index 154d4933d37..00000000000 --- a/packages/grid/ansible/roles/containers/tasks/main.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -- import_tasks: src.yml -- import_tasks: hagrid.yml -- import_tasks: tls.yml -- import_tasks: containers.yml diff --git a/packages/grid/ansible/roles/containers/tasks/src.yml b/packages/grid/ansible/roles/containers/tasks/src.yml deleted file mode 100644 index 1096fb4eced..00000000000 --- a/packages/grid/ansible/roles/containers/tasks/src.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- -- name: Kill Docker Containers - shell: "docker rm $(docker ps -qa) --force || true" - become_user: "{{ om_user }}" - ignore_errors: yes - -- name: Check Build Directory - stat: - path: "{{ build_dir }}" - get_checksum: no - get_md5: no - mime: no - register: build_dir_exists - -- name: Delete build directory - shell: "rm -rf {{ build_dir }} || true" - become: yes - ignore_errors: yes - when: build_dir_exists.stat.exists == True and vagrant is not defined and install == "true" - -- name: Copy code checkout to build - ansible.builtin.copy: - src: "{{ syft_dir }}/" - dest: "{{ build_dir }}" - force: yes - remote_src: yes - owner: "{{ om_user }}" - group: "{{ om_user }}" - become_user: "{{ om_user }}" - ignore_errors: yes - when: vagrant is not defined and install == "true" diff --git a/packages/grid/ansible/roles/containers/tasks/tls.yml b/packages/grid/ansible/roles/containers/tasks/tls.yml deleted file mode 100644 index 10910c9cce9..00000000000 --- a/packages/grid/ansible/roles/containers/tasks/tls.yml +++ /dev/null @@ -1,28 +0,0 @@ ---- -# these should only be run from your host to the target machine not during localhost -- name: Create cert_store_path - file: - path: "{{ cert_store_path }}" - state: directory - mode: 0600 - owner: "{{ om_user }}" - group: "{{ om_group }}" - when: install == "true" - -- name: Install key.pem - copy: - src: "{{ upload_tls_key }}" - dest: "{{ cert_store_path }}/key.pem" - owner: "{{ om_user }}" - group: "{{ om_user }}" - mode: 0600 - when: upload_tls_key != "" and install == "true" - -- name: Install cert.pem - copy: - src: "{{ upload_tls_cert }}" - dest: "{{ cert_store_path }}/cert.pem" - owner: "{{ om_user }}" - group: "{{ om_user }}" - mode: 0600 - when: upload_tls_cert != "" and install == "true" diff --git a/packages/grid/ansible/roles/jupyter/tasks/main.yml b/packages/grid/ansible/roles/jupyter/tasks/main.yml deleted file mode 100644 index 929f975b678..00000000000 --- a/packages/grid/ansible/roles/jupyter/tasks/main.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -- name: Install Tox - shell: "runuser -l {{ om_user }} -c 'pip install -U tox'" - become: yes - when: vagrant is not defined and jupyter == "true" - -- name: Keep Jupyter Notebooks server running - ansible.builtin.cron: - disabled: "{{ (jupyter == 'true') | ternary('false', 'true') }}" - name: "Jupyter Notebooks server" - job: "{{ syft_dir }}/packages/grid/scripts/jupyter.sh {{ syft_dir }} {{ om_user }} {{ jupyter_token }}" - become: yes - when: vagrant is not defined and jupyter == "true" diff --git a/packages/grid/ansible/roles/network/tasks/main.yml b/packages/grid/ansible/roles/network/tasks/main.yml deleted file mode 100644 index 81ac22ceff4..00000000000 --- a/packages/grid/ansible/roles/network/tasks/main.yml +++ /dev/null @@ -1,19 +0,0 @@ -# --- -# - name: Display all variables/facts known for a host -# ansible.builtin.debug: -# var: hostvars[inventory_hostname] -# verbosity: 1 - -# - name: Network Stuff -# shell: "echo network_stuff" -# become_user: "{{ om_user }}" -# ignore_errors: yes -# when: "'network' in group_names" - -# - name: Domain Stuff -# shell: "echo domain_stuff" -# become_user: "{{ om_user }}" -# ignore_errors: yes -# when: "'domain' in group_names" -# ## todo -# # apt install wireguard diff --git a/packages/grid/ansible/roles/node/handlers/main.yml b/packages/grid/ansible/roles/node/handlers/main.yml deleted file mode 100755 index 2965b21f99b..00000000000 --- a/packages/grid/ansible/roles/node/handlers/main.yml +++ /dev/null @@ -1,6 +0,0 @@ ---- -- name: restart docker - service: - name: docker - state: restarted - daemon_reload: yes diff --git a/packages/grid/ansible/roles/node/tasks/docker.yml b/packages/grid/ansible/roles/node/tasks/docker.yml deleted file mode 100755 index 49aa2c335b4..00000000000 --- a/packages/grid/ansible/roles/node/tasks/docker.yml +++ /dev/null @@ -1,105 +0,0 @@ ---- -- name: Install Docker GPG Key - apt_key: - id: 7EA0A9C3F273FCD8 - url: https://download.docker.com/linux/ubuntu/gpg - state: present - -- name: Install Docker Repo - apt_repository: - repo: deb https://download.docker.com/linux/ubuntu focal stable - state: present - -- name: Install Docker Packages - package: - name: "{{ item }}" - state: present - update_cache: yes - autoclean: yes - loop: - - apt-transport-https - - ca-certificates - - curl - - gnupg - - lsb-release - - docker-ce - - docker-ce-cli - - containerd.io - -- name: Get the system architecture - ansible.builtin.setup: - gather_subset: hardware - register: system_info - -- name: Set docker compose arm64 binary URL - set_fact: - docker_compose_binary_url: "{{ docker_compose_url_arm64 }}" - when: "'aarch64' in system_info['ansible_facts']['ansible_architecture']" - -- name: Set docker compose x86 binary URL - set_fact: - docker_compose_binary_url: "{{ docker_compose_url_x86 }}" - when: "'x86' in system_info['ansible_facts']['ansible_architecture']" - -- name: Install Docker Compose - stat: - path: "{{ om_homedir }}/{{ docker_compose_plugin_dir }}" - get_checksum: no - get_md5: no - mime: no - register: docker_cli_dir_present - -- name: Create Docker Compose Plugin Dir - file: - path: "{{ om_homedir }}/{{ docker_compose_plugin_dir }}" - state: directory - mode: "0755" - owner: "{{ om_user }}" - group: "{{ om_user }}" - become: yes - -- name: Create Docker Compose Plugin Dir root - file: - path: "{{ root_homedir }}/{{ docker_compose_plugin_dir }}" - state: directory - mode: "0770" - owner: "{{ root_user }}" - group: "{{ root_user }}" - become: yes - -- name: Download Docker CLI - get_url: - url: "{{ docker_compose_binary_url }}" - dest: "{{ om_homedir }}/{{ docker_compose_plugin_dir }}/docker-compose" - when: docker_cli_dir_present.stat.exists == False - -- name: Download Docker CLI root - get_url: - url: "{{ docker_compose_binary_url }}" - dest: "{{ root_homedir }}/{{ docker_compose_plugin_dir }}/docker-compose" - become: yes - when: docker_cli_dir_present.stat.exists == False - -- name: Change permissions - file: - path: "{{ om_homedir }}/{{ docker_compose_plugin_dir }}/docker-compose" - state: touch - mode: a+x - owner: "{{ om_user }}" - group: "{{ om_user }}" - become: yes - -- name: Change permissions for root - file: - path: "{{ root_homedir }}/{{ docker_compose_plugin_dir }}/docker-compose" - state: touch - mode: a+x - owner: "{{ root_user }}" - group: "{{ root_user }}" - become: yes - -- name: Ensuring docker service is always running - systemd: - enabled: yes - state: started - name: docker diff --git a/packages/grid/ansible/roles/node/tasks/main.yml b/packages/grid/ansible/roles/node/tasks/main.yml deleted file mode 100755 index 929d975537c..00000000000 --- a/packages/grid/ansible/roles/node/tasks/main.yml +++ /dev/null @@ -1,47 +0,0 @@ ---- -- name: Display all variables/facts known for a host - ansible.builtin.debug: - var: hostvars[inventory_hostname] - verbosity: 0 - -- name: Stop existing cronjobs if provisioning from outside - shell: (crontab -r || true) && sudo kill -9 $(pgrep cron) - become: yes - when: inventory_hostname != "localhost" - -- name: Stop existing ansible provisioning running against localhost - shell: pgrep ansible | xargs -I {} bash -c "ps -o cmd fp {} | grep 'connection=local' | kill {}" - become: yes - when: inventory_hostname != "localhost" - -- name: Apply system changes - import_tasks: system.yml - when: deploy_only is not defined and install == "true" - -- name: Apply security updates - import_tasks: security.yml - when: deploy_only is not defined and install == "true" - -- name: Install docker - import_tasks: docker.yml - when: deploy_only is not defined and install == "true" - -- name: Archive Logs - ansible.builtin.cron: - disabled: "{{ not install | bool }}" - minute: "0" - hour: "0" - name: "Archive Logs" - job: "{{ syft_dir }}/packages/grid/scripts/rotate_logs.sh 2>&1 | logger -t cron" - become: yes - when: vagrant is not defined - -- name: Clone PySyft Repo - git: - repo: "https://github.com/{{ github_repo }}" - dest: "{{ syft_dir }}" - version: "{{ repo_branch }}" - force: yes - become_user: "{{ om_user }}" - ignore_errors: yes - when: vagrant is not defined diff --git a/packages/grid/ansible/roles/node/tasks/security.yml b/packages/grid/ansible/roles/node/tasks/security.yml deleted file mode 100644 index 38fc1ccc655..00000000000 --- a/packages/grid/ansible/roles/node/tasks/security.yml +++ /dev/null @@ -1,8 +0,0 @@ -- name: Install Security Updates - package: - name: "{{ item }}" - state: present - autoclean: yes - update_cache: yes - loop: - - policykit-1 diff --git a/packages/grid/ansible/roles/node/tasks/system.yml b/packages/grid/ansible/roles/node/tasks/system.yml deleted file mode 100755 index 91ecbbf1a6b..00000000000 --- a/packages/grid/ansible/roles/node/tasks/system.yml +++ /dev/null @@ -1,133 +0,0 @@ ---- -# - name: Install security updates -# shell: "sudo apt list --upgradable | grep security |cut -d\/ -f1|xargs sudo apt-get install -y --only-upgrade" -# become: yes -# args: -# executable: /bin/bash - -- name: Allow sudo without password - ansible.builtin.lineinfile: - path: /etc/sudoers - state: present - regexp: "^%sudo" - line: "%sudo ALL=(ALL) NOPASSWD: ALL" - validate: "visudo -cf %s" - -- name: Create docker group - group: - name: "docker" - state: present - -- name: Create om group - group: - name: "{{ om_group }}" - state: present - -- name: Create om user - user: - name: "{{ om_user }}" - append: yes - createhome: yes - -- name: Add user to om and docker - user: - name: "{{ om_user }}" - comment: "OpenMined user for running node" - groups: - - "{{ om_group }}" - - sudo - - docker - shell: /bin/bash - -- name: Give permission to home dir - file: - path: "{{ om_homedir }}" - state: directory - mode: "0775" - owner: "{{ om_user }}" - group: "{{ om_group }}" - # recurse: yes - -- name: Add user to vagrant group - user: - name: "{{ om_user }}" - groups: - - vagrant - append: yes - when: vagrant is defined - -- name: Add vagrant user to docker - user: - name: "vagrant" - groups: - - vagrant - - docker - - om - append: yes - when: vagrant is defined - -- name: Install System Packages - package: - name: "{{ item }}" - state: present - autoclean: yes - update_cache: yes - loop: - - acl - - python3-pip - - ntp - - tmux - - vim - - ufw - - git - - python-is-python3 - - net-tools - - ifupdown - - python3-venv - - cron - -- name: Upgrade pip and some packages - pip: - name: pip - extra_args: --upgrade - -- name: Check ctop exists - stat: - path: /usr/local/bin/ctop - register: ctop_exists - -- name: Get the system architecture - ansible.builtin.setup: - gather_subset: hardware - register: system_info - -- name: Install ctop Docker CLI Utility - arm64 - shell: sudo wget https://github.com/bcicen/ctop/releases/download/v0.7.7/ctop-0.7.7-linux-arm64 -O /usr/local/bin/ctop && sudo chmod +x /usr/local/bin/ctop - become: yes - when: "not ctop_exists.stat.exists and 'aarch64' in system_info['ansible_facts']['ansible_architecture']" - -- name: Install ctop Docker CLI Utility - x86 - shell: sudo wget https://github.com/bcicen/ctop/releases/download/v0.7.7/ctop-0.7.7-linux-amd64 -O /usr/local/bin/ctop && sudo chmod +x /usr/local/bin/ctop - become: yes - when: "not ctop_exists.stat.exists and 'x86' in system_info['ansible_facts']['ansible_architecture']" - -- name: Ensuring ufw service is always running - systemd: - enabled: yes - state: started - name: ufw - when: wsl is not defined - -- name: Set timezone to UTC - timezone: - name: UTC - -- name: Ensuring ntp service is always running - systemd: - enabled: yes - state: started - name: ntp - -- name: Set git dir as safe - shell: git config --global --add safe.directory {{ syft_dir }} - become: yes diff --git a/packages/grid/ansible/roles/update/tasks/main.yml b/packages/grid/ansible/roles/update/tasks/main.yml deleted file mode 100644 index 170ca4f26ae..00000000000 --- a/packages/grid/ansible/roles/update/tasks/main.yml +++ /dev/null @@ -1,37 +0,0 @@ ---- -# cronjob logs: $ tail -f /var/log/syslog | grep -i cron -# - name: PySyft Repo Update Cron Job -# ansible.builtin.cron: -# disabled: "{{ not install | bool }}" -# minute: "*/2" -# name: "Update PySyft Repo" -# job: "{{ syft_dir }}/packages/grid/scripts/cron.sh {{ syft_dir }} {{ github_repo }} {{ repo_branch }} {{ om_user }} {{ om_group }} {{ node_type }} {{ node_name }} {{ build_dir }} {{ tls }} {{ cert_store_path }} {{ release }} {{ docker_tag }} 2>&1 | logger -t cron" -# become: yes -# when: vagrant is not defined - -- name: Keep Containers Running - ansible.builtin.cron: - disabled: "{{ not install | bool }}" - name: "Restart Containers" - job: "{{ syft_dir }}/packages/grid/scripts/containers.sh" - become: yes - when: vagrant is not defined - -- name: - copy: - src: "../../../../scripts/" - dest: "{{ cert_store_path }}/cert.pem" - owner: "{{ om_user }}" - group: "{{ om_user }}" - mode: 0600 - when: upload_tls_cert != "" and install == "true" - -- name: Run containers.sh on startup - ansible.builtin.template: - src: "../../../../scripts/rc.local.j2" - dest: /etc/rc.local - owner: root - group: root - mode: "0655" - become: yes - when: vagrant is not defined diff --git a/packages/grid/ansible/site.yml b/packages/grid/ansible/site.yml deleted file mode 100755 index f0c14773983..00000000000 --- a/packages/grid/ansible/site.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -- hosts: all - gather_facts: False - environment: - LC_ALL: en_US.UTF-8 - become: yes - roles: - - node - - jupyter - - containers - - update - - aa_demo diff --git a/tox.ini b/tox.ini index c79fa513cb1..e1e4cfa36d7 100644 --- a/tox.ini +++ b/tox.ini @@ -235,7 +235,6 @@ deps = {[testenv:syft]deps} commands = bandit -r src - # ansible 8.4.0 # restrictedpython 6.2 safety check -i 60840 -i 54229 -i 54230 -i 42923 -i 54230 -i 54229 -i 62044 -i 65213 -i 54564 From 25e9b553b1fa0e6a746ec724ebb619b883e9b1ba Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:04:42 +0530 Subject: [PATCH 04/15] remove packer --- packages/grid/packer/Vagrantfile | 25 ------- packages/grid/packer/azure.pkr.hcl | 67 ----------------- packages/grid/packer/base.pkr.hcl | 46 ------------ packages/grid/packer/build_azure.sh | 3 - packages/grid/packer/build_vagrant.sh | 5 -- packages/grid/packer/cloud-config/meta-data | 0 packages/grid/packer/cloud-config/user-data | 30 -------- packages/grid/packer/domain.pkr.hcl | 33 --------- packages/grid/packer/scripts/cleanup.sh | 81 --------------------- packages/grid/packer/scripts/hyperv.sh | 12 --- packages/grid/packer/scripts/minimize.sh | 36 --------- packages/grid/packer/scripts/motd.sh | 21 ------ packages/grid/packer/scripts/update.sh | 40 ---------- 13 files changed, 399 deletions(-) delete mode 100644 packages/grid/packer/Vagrantfile delete mode 100644 packages/grid/packer/azure.pkr.hcl delete mode 100644 packages/grid/packer/base.pkr.hcl delete mode 100755 packages/grid/packer/build_azure.sh delete mode 100755 packages/grid/packer/build_vagrant.sh delete mode 100644 packages/grid/packer/cloud-config/meta-data delete mode 100644 packages/grid/packer/cloud-config/user-data delete mode 100644 packages/grid/packer/domain.pkr.hcl delete mode 100644 packages/grid/packer/scripts/cleanup.sh delete mode 100755 packages/grid/packer/scripts/hyperv.sh delete mode 100644 packages/grid/packer/scripts/minimize.sh delete mode 100644 packages/grid/packer/scripts/motd.sh delete mode 100644 packages/grid/packer/scripts/update.sh diff --git a/packages/grid/packer/Vagrantfile b/packages/grid/packer/Vagrantfile deleted file mode 100644 index c42c7d5be1d..00000000000 --- a/packages/grid/packer/Vagrantfile +++ /dev/null @@ -1,25 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : - -VAGRANTFILE_API_VERSION = "2" - -Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| - - config.ssh.username = "ubuntu" - config.ssh.password = "ubuntu" - - config.vm.define "domain" do |node| - node.vm.box = "output-domain/openmined.domain.ubuntu2004.box" - node.vm.box_check_update = false - - node.vm.hostname = "node.openmined.grid" - node.vm.network :private_network, ip: "192.168.56.2", - virtualbox__intnet: true - node.vm.network "forwarded_port", guest: 80, host: 8080 - - node.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.name = "domain" - end - end -end diff --git a/packages/grid/packer/azure.pkr.hcl b/packages/grid/packer/azure.pkr.hcl deleted file mode 100644 index 9d79e5a13d1..00000000000 --- a/packages/grid/packer/azure.pkr.hcl +++ /dev/null @@ -1,67 +0,0 @@ -variable "appId" { - type = string - default = "" - sensitive = true -} - -variable "displayName" {} - -variable "password" { - type = string - default = "" - sensitive = true -} - -variable "tenant" { - type = string - default = "" - sensitive = true -} - -variable "subscription_id" { - type = string - default = "" - sensitive = true -} - -source "azure-arm" "domain" { - azure_tags = { - node_type = "domain" - os_version = "ubuntu2004" - } - client_id = "${var.appId}" - client_secret = "${var.password}" - image_publisher = "canonical" - image_offer = "0001-com-ubuntu-server-focal" - image_version = "latest" - image_sku = "20_04-lts" - location = "West US" - os_type = "Linux" - subscription_id = "${var.subscription_id}" - tenant_id = "${var.tenant}" - vm_size = "Standard_D4s_v3" - os_disk_size_gb = 128 - # vhd - # capture_container_name = "openmined-domain-ubuntu2004" # vhd - # capture_name_prefix = "openmined-domain" # vhd - # resource_group_name = "openmined-images" # vhd - # storage_account = "openminedimgs" # vhd - # managed image - managed_image_name = "openmined-domain-ubuntu2004-5" # managed image - managed_image_resource_group_name = "openmined-images" # managed image -} - -build { - name = "openmined.node.domain" - sources = ["source.azure-arm.domain"] - - provisioner "ansible" { - playbook_file = "../ansible/site.yml" - extra_arguments = [ "-v", "-e", "packer=true", "-e", "repo_branch=0.7.0" ] - } - - provisioner "shell" { - expect_disconnect = true - scripts = ["${path.root}/scripts/update.sh", "${path.root}/scripts/motd.sh", "${path.root}/scripts/hyperv.sh", "${path.root}/scripts/cleanup.sh"] - } -} diff --git a/packages/grid/packer/base.pkr.hcl b/packages/grid/packer/base.pkr.hcl deleted file mode 100644 index d88b509d8b3..00000000000 --- a/packages/grid/packer/base.pkr.hcl +++ /dev/null @@ -1,46 +0,0 @@ -variable "ubuntu_version" { - type = string - default = "20.04.5" - sensitive = true -} - -source "virtualbox-iso" "ubuntu2004" { - boot_command = [ - " ", - "autoinstall", - ] - cd_files = [ - "./cloud-config/meta-data", - "./cloud-config/user-data" - ] - cd_label = "cidata" - boot_wait = "5s" - guest_os_type = "ubuntu-64" - iso_checksum = "file:http://no.releases.ubuntu.com/${var.ubuntu_version}/SHA256SUMS" - iso_url = "http://no.releases.ubuntu.com/${var.ubuntu_version}/ubuntu-${var.ubuntu_version}-live-server-amd64.iso" - memory = 4096 - disk_size = 64000 - output_directory = "output-base" - output_filename = "openmined.base.ubuntu2004" - shutdown_command = "sudo shutdown -P now" - ssh_handshake_attempts = "1000" - ssh_password = "ubuntu" - ssh_pty = true - ssh_timeout = "20m" - ssh_username = "ubuntu" - host_port_min = 2222 - host_port_max = 2222 -} - -build { - name = "openmined.node.base" - sources = ["source.virtualbox-iso.ubuntu2004"] - - provisioner "shell" { - inline = ["echo initial provisioning"] - } - - post-processor "manifest" { - output = "base-manifest.json" - } -} diff --git a/packages/grid/packer/build_azure.sh b/packages/grid/packer/build_azure.sh deleted file mode 100755 index 9c839fa62c5..00000000000 --- a/packages/grid/packer/build_azure.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash -packer init azure.pkr.hcl -PACKER_LOG=1 PACKER_LOG_PATH=./packer.log packer build -var-file=azure_vars.json -on-error=ask -var "subscription_id=${1}" azure.pkr.hcl diff --git a/packages/grid/packer/build_vagrant.sh b/packages/grid/packer/build_vagrant.sh deleted file mode 100755 index cd54ffb9c36..00000000000 --- a/packages/grid/packer/build_vagrant.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash -packer init base.pkr.hcl -packer init domain.pkr.hcl -PACKER_LOG=1 PACKER_LOG_PATH=./packer.log packer build -on-error=ask base.pkr.hcl -PACKER_LOG=1 PACKER_LOG_PATH=./packer.log packer build -on-error=ask domain.pkr.hcl \ No newline at end of file diff --git a/packages/grid/packer/cloud-config/meta-data b/packages/grid/packer/cloud-config/meta-data deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/packages/grid/packer/cloud-config/user-data b/packages/grid/packer/cloud-config/user-data deleted file mode 100644 index 000b0317d62..00000000000 --- a/packages/grid/packer/cloud-config/user-data +++ /dev/null @@ -1,30 +0,0 @@ -#cloud-config -autoinstall: - version: 1 - locale: en_US - keyboard: - layout: en - variant: us - network: - version: 2 - ethernets: - enp0s3: - dhcp4: true - storage: - layout: - name: lvm - identity: - hostname: ubuntu - username: ubuntu - password: "$6$exDY1mhS4KUYCE/2$zmn9ToZwTKLhCw.b4/b.ZRTIZM30JZ4QrOQ2aOXJ8yk96xpcCof0kxKwuX1kqLG/ygbJ1f8wxED22bTL4F46P0" - user-data: - disable_root: false - ssh: - install-server: true - allow-pw: true - early-commands: - # otherwise packer tries to connect and exceed max attempts: - - sudo systemctl stop ssh - late-commands: - - 'sed -i "s/dhcp4: true/&\n dhcp-identifier: mac/" /target/etc/netplan/00-installer-config.yaml' - - echo 'ubuntu ALL=(ALL) NOPASSWD:ALL' > /target/etc/sudoers.d/ubuntu diff --git a/packages/grid/packer/domain.pkr.hcl b/packages/grid/packer/domain.pkr.hcl deleted file mode 100644 index 93a6564c5b5..00000000000 --- a/packages/grid/packer/domain.pkr.hcl +++ /dev/null @@ -1,33 +0,0 @@ -source "virtualbox-ovf" "domain" { - shutdown_command = "echo 'vagrant' | sudo -S shutdown -P now" - source_path = "output-base/openmined.base.ubuntu2004.ovf" - ssh_password = "ubuntu" - ssh_port = 22 - ssh_username = "ubuntu" - host_port_min = 2222 - host_port_max = 2222 - output_directory = "output-domain" - output_filename = "openmined.domain.ubuntu2004" -} - -build { - name = "openmined.node.domain" - sources = ["source.virtualbox-ovf.domain"] - - provisioner "ansible" { - playbook_file = "../ansible/site.yml" - extra_arguments = [ "-v", "-e", "packer=true", "-e", "repo_branch=0.7.0" ] - } - - provisioner "shell" { - expect_disconnect = true - scripts = ["${path.root}/scripts/update.sh", "${path.root}/scripts/motd.sh", "${path.root}/scripts/hyperv.sh", "${path.root}/scripts/cleanup.sh", "${path.root}/scripts/minimize.sh"] - } - - post-processor "vagrant" { - keep_input_artifact = true - provider_override = "virtualbox" - output = "output-domain/openmined.domain.ubuntu2004.box" - vagrantfile_template = "Vagrantfile" - } -} diff --git a/packages/grid/packer/scripts/cleanup.sh b/packages/grid/packer/scripts/cleanup.sh deleted file mode 100644 index f07c8054368..00000000000 --- a/packages/grid/packer/scripts/cleanup.sh +++ /dev/null @@ -1,81 +0,0 @@ -#!/bin/sh -eux - -# Delete all Linux headers -sudo dpkg --list \ -| awk '{ print $2 }' \ -| grep 'linux-headers' \ -| xargs sudo apt-get -y purge; - -# Remove specific Linux kernels, such as linux-image-3.11.0-15-generic but -# keeps the current kernel and does not touch the virtual packages, -# e.g. 'linux-image-generic', etc. -sudo dpkg --list \ -| awk '{ print $2 }' \ -| grep 'linux-image-.*-generic' \ -| grep -v `uname -r` \ -| xargs sudo apt-get -y purge; - -# Delete Linux source -sudo dpkg --list \ -| awk '{ print $2 }' \ -| grep linux-source \ -| xargs sudo apt-get -y purge; - -# Delete development packages -sudo dpkg --list \ -| awk '{ print $2 }' \ -| grep -- '-dev$' \ -| xargs sudo apt-get -y purge; - -# delete docs packages -sudo dpkg --list \ -| awk '{ print $2 }' \ -| grep -- '-doc$' \ -| xargs sudo apt-get -y purge; - -# Delete X11 libraries -sudo apt-get -y purge libx11-data xauth libxmuu1 libxcb1 libx11-6 libxext6; - -# Delete obsolete networking -sudo apt-get -y purge ppp pppconfig pppoeconf; - -# Delete oddities -sudo apt-get -y purge popularity-contest installation-report command-not-found friendly-recovery bash-completion fonts-ubuntu-font-family-console laptop-detect; - -# 19.10+ don't have this package so fail gracefully -sudo apt-get -y purge command-not-found-data || true; - -# Exlude the files we don't need w/o uninstalling linux-firmware -echo "==> Setup dpkg excludes for linux-firmware" -sudo su -c 'cat <<_EOF_ | cat >> /etc/dpkg/dpkg.cfg.d/excludes -#OM-BEGIN -path-exclude=/lib/firmware/* -path-exclude=/usr/share/doc/linux-firmware/* -#OM-END -_EOF_' - -# Delete the massive firmware packages -sudo rm -rf /lib/firmware/* -sudo rm -rf /usr/share/doc/linux-firmware/* - -sudo apt-get -y autoremove; -sudo apt-get -y clean; - -# Remove docs -sudo rm -rf /usr/share/doc/* - -# Remove caches -sudo find /var/cache -type f -exec rm -rf {} \; - -# truncate any logs that have built up during the install -sudo find /var/log -type f -exec truncate --size=0 {} \; - -# Blank netplan machine-id (DUID) so machines get unique ID generated on boot. -sudo truncate -s 0 /etc/machine-id - -# remove the contents of /tmp and /var/tmp -sudo rm -rf /tmp/* /var/tmp/* - -# clear the history so our install isn't there -export HISTSIZE=0 -sudo rm -f /root/.wget-hsts \ No newline at end of file diff --git a/packages/grid/packer/scripts/hyperv.sh b/packages/grid/packer/scripts/hyperv.sh deleted file mode 100755 index 293dd6d1f62..00000000000 --- a/packages/grid/packer/scripts/hyperv.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh -eux -ubuntu_version=$(lsb_release -r | awk '{print $2}') -major_version=$(echo $ubuntu_version | awk -F. '{print $1}') - -case "$PACKER_BUILDER_TYPE" in - hyperv-iso) - if [ "$major_version" -eq "16" ]; then - sudo apt-get install -y linux-tools-virtual-lts-xenial linux-cloud-tools-virtual-lts-xenial; - else - sudo apt-get -y install linux-image-virtual linux-tools-virtual linux-cloud-tools-virtual; - fi -esac diff --git a/packages/grid/packer/scripts/minimize.sh b/packages/grid/packer/scripts/minimize.sh deleted file mode 100644 index feed5a009f9..00000000000 --- a/packages/grid/packer/scripts/minimize.sh +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/sh -eux - -case "$PACKER_BUILDER_TYPE" in - qemu) exit 0 ;; -esac - -# Whiteout root -count=$(df --sync -kP / | tail -n1 | awk -F ' ' '{print $4}') -count=$(($count-1)) -sudo dd if=/dev/zero of=/tmp/whitespace bs=1M count=$count || echo "dd exit code $? is suppressed"; -sudo rm /tmp/whitespace - -# Whiteout /boot -count=$(df --sync -kP /boot | tail -n1 | awk -F ' ' '{print $4}') -count=$(($count-1)) -sudo dd if=/dev/zero of=/boot/whitespace bs=1M count=$count || echo "dd exit code $? is suppressed"; -sudo rm /boot/whitespace - -set +e -swapuuid="`/sbin/blkid -o value -l -s UUID -t TYPE=swap`"; -case "$?" in - 2|0) ;; - *) exit 1 ;; -esac -set -e - -if [ "x${swapuuid}" != "x" ]; then - # Whiteout the swap partition to reduce box size - # Swap is disabled till reboot - sudo swappart="`readlink -f /dev/disk/by-uuid/$swapuuid`"; - sudo /sbin/swapoff "$swappart"; - sudo dd if=/dev/zero of="$swappart" bs=1M || echo "dd exit code $? is suppressed"; - sudo /sbin/mkswap -U "$swapuuid" "$swappart"; -fi - -sudo sync; diff --git a/packages/grid/packer/scripts/motd.sh b/packages/grid/packer/scripts/motd.sh deleted file mode 100644 index ea5dd260b35..00000000000 --- a/packages/grid/packer/scripts/motd.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/bin/sh -eux - -msg=' -This system is built by OpenMined. -More information can be found at https://github.com/OpenMined/PySyft' - -if [ -d /etc/update-motd.d ]; then - MOTD_CONFIG='/etc/update-motd.d/99-grid' - -sudo su -c "cat >> $MOTD_CONFIG <> /etc/motd' -fi diff --git a/packages/grid/packer/scripts/update.sh b/packages/grid/packer/scripts/update.sh deleted file mode 100644 index a69e0ca20bd..00000000000 --- a/packages/grid/packer/scripts/update.sh +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/sh -eux -export DEBIAN_FRONTEND=noninteractive - -ubuntu_version=$(lsb_release -r | awk '{print $2}') -major_version=$(echo $ubuntu_version | awk -F. '{print $1}') - -# Disable release-upgrades -sudo sed -i.bak 's/^Prompt=.*$/Prompt=never/' /etc/update-manager/release-upgrades; - -# Disable systemd apt timers/services -if [ "$major_version" -ge "16" ]; then - sudo systemctl stop apt-daily.timer; - sudo systemctl stop apt-daily-upgrade.timer; - sudo systemctl disable apt-daily.timer; - sudo systemctl disable apt-daily-upgrade.timer; - sudo systemctl mask apt-daily.service; - sudo systemctl mask apt-daily-upgrade.service; - sudo systemctl daemon-reload; -fi - -# Disable periodic activities of apt to be safe -sudo su -c "cat </etc/apt/apt.conf.d/10periodic; -APT::Periodic::Enable "0"; -APT::Periodic::Update-Package-Lists "0"; -APT::Periodic::Download-Upgradeable-Packages "0"; -APT::Periodic::AutocleanInterval "0"; -APT::Periodic::Unattended-Upgrade "0"; -EOF"; - -# Clean and nuke the package from orbit -sudo rm -rf /var/log/unattended-upgrades; -sudo apt-get -y purge unattended-upgrades; - -# Update the package list -sudo apt-get -y update; - -# Upgrade all installed packages incl. kernel and kernel headers -sudo apt-get -y dist-upgrade -o Dpkg::Options::="--force-confnew"; - -sudo reboot From 3c9714eaad5915dc009c309c9cce3fb899dff110 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:06:05 +0530 Subject: [PATCH 05/15] remove vagrant --- .../vagrant/almalinux_9/arm_64/Vagrantfile | 38 -------------- .../vagrant/almalinux_9/x86_64/Vagrantfile | 37 -------------- .../grid/vagrant/fedora_38/arm_64/Vagrantfile | 35 ------------- .../grid/vagrant/fedora_38/x86_64/Vagrantfile | 35 ------------- tox.ini | 49 +------------------ 5 files changed, 1 insertion(+), 193 deletions(-) delete mode 100644 packages/grid/vagrant/almalinux_9/arm_64/Vagrantfile delete mode 100644 packages/grid/vagrant/almalinux_9/x86_64/Vagrantfile delete mode 100644 packages/grid/vagrant/fedora_38/arm_64/Vagrantfile delete mode 100644 packages/grid/vagrant/fedora_38/x86_64/Vagrantfile diff --git a/packages/grid/vagrant/almalinux_9/arm_64/Vagrantfile b/packages/grid/vagrant/almalinux_9/arm_64/Vagrantfile deleted file mode 100644 index 617003eb4f2..00000000000 --- a/packages/grid/vagrant/almalinux_9/arm_64/Vagrantfile +++ /dev/null @@ -1,38 +0,0 @@ -Vagrant.configure("2") do |config| - config.vm.box = "almalinux/9.aarch64" - config.vm.hostname = "almalinux-9" - - config.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.cpus = "2" - end - - config.vm.provider "vmware_desktop" do |vd| - vd.memory = "4096" - vd.cpus = "2" - end - - config.vm.box_check_update = false - - config.vm.provision "shell", inline: <<-SHELL - #!/bin/bash - echo "Hello from the inline Bash script!" - # Flush existing rules - iptables-save > rules.v4.old - iptables -F - - # Set the default policies to DROP - iptables -P INPUT DROP - iptables -P FORWARD DROP - iptables -P OUTPUT ACCEPT - - # Allow incoming SSH traffic - iptables -A INPUT -p tcp --dport 22 -j ACCEPT - - # Save the rules so they persist across reboots - iptables-save > rules.v4.new - pwd - - SHELL - - end \ No newline at end of file diff --git a/packages/grid/vagrant/almalinux_9/x86_64/Vagrantfile b/packages/grid/vagrant/almalinux_9/x86_64/Vagrantfile deleted file mode 100644 index 20fe9b8d652..00000000000 --- a/packages/grid/vagrant/almalinux_9/x86_64/Vagrantfile +++ /dev/null @@ -1,37 +0,0 @@ -Vagrant.configure("2") do |config| - config.vm.box = "almalinux/9" - config.vm.hostname = "almalinux-9" - - config.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.cpus = "2" - end - - config.vm.provider "vmware_desktop" do |vd| - vd.memory = "4096" - vd.cpus = "2" - end - config.vm.box_check_update = false - - config.vm.provision "shell", inline: <<-SHELL - #!/bin/bash - echo "Hello from the inline Bash script!" - # Flush existing rules - iptables-save > rules.v4.old - iptables -F - - # Set the default policies to DROP - iptables -P INPUT DROP - iptables -P FORWARD DROP - iptables -P OUTPUT ACCEPT - - # Allow incoming SSH traffic - iptables -A INPUT -p tcp --dport 22 -j ACCEPT - - # Save the rules so they persist across reboots - iptables-save > rules.v4.new - pwd - - SHELL - - end \ No newline at end of file diff --git a/packages/grid/vagrant/fedora_38/arm_64/Vagrantfile b/packages/grid/vagrant/fedora_38/arm_64/Vagrantfile deleted file mode 100644 index 8d4d9b73445..00000000000 --- a/packages/grid/vagrant/fedora_38/arm_64/Vagrantfile +++ /dev/null @@ -1,35 +0,0 @@ -Vagrant.configure("2") do |config| - config.vm.box = "bento/fedora-38-arm64" - config.vm.hostname = "fedora-38-arm64" - - config.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.cpus = "2" - end - - config.vm.provider "vmware_desktop" do |vd| - vd.memory = "4096" - vd.cpus = "2" - end - config.vm.synced_folder "../../../podman/podman-kube", "/home/vagrant/podman-kube" ,type: "rsync" - config.vm.box_check_update = false - config.vm.network "forwarded_port", guest: 8080, host: 8080, host_ip: "127.0.0.1" - - config.vm.provision "shell", inline: <<-SHELL - # Run shell script on the home folder - cd ~ - sudo dnf install podman -y - pwd - SHELL - - config.vm.provision "shell",privileged: false, inline: <<-SHELL - # Run shell script on the home folder - pwd - whoami - cd ~/podman-kube - podman play kube podman-syft-kube.yaml --configmap=podman-syft-kube-config.yaml - pwd - SHELL - - - end \ No newline at end of file diff --git a/packages/grid/vagrant/fedora_38/x86_64/Vagrantfile b/packages/grid/vagrant/fedora_38/x86_64/Vagrantfile deleted file mode 100644 index b39b162957c..00000000000 --- a/packages/grid/vagrant/fedora_38/x86_64/Vagrantfile +++ /dev/null @@ -1,35 +0,0 @@ -Vagrant.configure("2") do |config| - config.vm.box = "bento/fedora-38" - config.vm.hostname = "fedora-38-x86_64" - - config.vm.provider "virtualbox" do |vb| - vb.memory = "4096" - vb.cpus = "2" - end - - config.vm.provider "vmware_desktop" do |vd| - vd.memory = "4096" - vd.cpus = "2" - end - config.vm.synced_folder "../../../podman/podman-kube", "/home/vagrant/podman-kube" ,type: "rsync" - config.vm.box_check_update = false - config.vm.network "forwarded_port", guest: 8080, host: 8080, host_ip: "127.0.0.1" - - config.vm.provision "shell", inline: <<-SHELL - # Run shell script on the home folder - cd ~ - sudo dnf install podman -y - pwd - SHELL - - config.vm.provision "shell",privileged: false, inline: <<-SHELL - # Run shell script on the home folder - pwd - whoami - cd ~/podman-kube - podman play kube podman-syft-kube.yaml --configmap=podman-syft-kube-config.yaml - pwd - SHELL - - - end \ No newline at end of file diff --git a/tox.ini b/tox.ini index e1e4cfa36d7..5aa24441f8e 100644 --- a/tox.ini +++ b/tox.ini @@ -355,54 +355,7 @@ commands = bash -c 'docker volume rm -f $(docker volume ls -q --filter "label=com.docker.volume.anonymous") || true' bash -c 'docker network rm -f $(docker network ls -q --filter "label=orgs.openmined.syft") || true' -[testenv:stack.test.vm] -description = Stack VM Tests -deps = - {[testenv:syft]deps} - nbmake -allowlist_externals = - cd - vagrant - bash -changedir = {toxinidir} -setenv = - ORCHESTRA_DEPLOYMENT_TYPE = {env:ORCHESTRA_DEPLOYMENT_TYPE:vm} - VAGRANT_DESTROY = {env:VAGRANT_DESTROY:skip} -commands = - bash -c 'if [[ "$(uname -m)" == *"arm"* ]]; then \ - export VAGRANT_BOX="ubuntu-22-04-arm64"; \ - elif [[ "$(uname -m)" == *"x86"* ]]; then \ - export VAGRANT_BOX="ubuntu-22-04-x86"; \ - else \ - echo "Unsupported architecture."; \ - fi; \ - echo $VAGRANT_BOX; \ - cd packages/grid; \ - if [[ "$VAGRANT_DESTROY" == *"true"* ]]; then \ - vagrant destroy $VAGRANT_BOX --force || true; \ - else \ - vagrant ssh $VAGRANT_BOX -c "docker ps -aq | xargs -I {:} docker rm {:} --force"; \ - vagrant ssh $VAGRANT_BOX -c "docker volume prune --filter all=1 --force || true"; \ - fi; \ - vagrant up $VAGRANT_BOX --provision; \ - ' - - pytest -x --nbmake --nbmake-timeout=1000 notebooks/api/0.8 -p no:randomly -vvvv - ; pytest -x --nbmake --nbmake-timeout=1000 notebooks/api/0.9 -p no:randomly -vvvv - - bash -c 'if [[ "$(uname -m)" == *"arm"* ]]; then \ - export VAGRANT_BOX="ubuntu-22-04-arm64"; \ - elif [[ "$(uname -m)" == *"x86"* ]]; then \ - export VAGRANT_BOX="ubuntu-22-04-x86"; \ - else \ - echo "Unsupported architecture."; \ - fi; \ - echo $VAGRANT_BOX; \ - cd packages/grid; \ - if [[ "$VAGRANT_DESTROY" == *"true"* ]]; then \ - vagrant destroy $VAGRANT_BOX --force || true; \ - fi; \ - ' + [testenv:stack.test.podman] description = Stack podman Tests for Rhel & Centos From 574440e884012e42175cb01ccc92d70f5e2d36ed Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:09:40 +0530 Subject: [PATCH 06/15] remove podman --- .bumpversion.cfg | 4 - .github/workflows/cd-syft.yml | 2 +- .github/workflows/rhel-tests.yml | 50 --------- README.md | 4 +- .../podman-kube/podman-syft-kube-config.yaml | 104 ------------------ .../podman/podman-kube/podman-syft-kube.yaml | 92 ---------------- .../podman-kube/traefik/conf/dynamic.yml | 28 ----- .../podman/podman-kube/traefik/traefik.yml | 18 --- packages/syftcli/manifest.yml | 5 - tox.ini | 34 ------ 10 files changed, 3 insertions(+), 338 deletions(-) delete mode 100644 .github/workflows/rhel-tests.yml delete mode 100644 packages/grid/podman/podman-kube/podman-syft-kube-config.yaml delete mode 100644 packages/grid/podman/podman-kube/podman-syft-kube.yaml delete mode 100644 packages/grid/podman/podman-kube/traefik/conf/dynamic.yml delete mode 100644 packages/grid/podman/podman-kube/traefik/traefik.yml diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 9d7d355d5b5..bc1454f470f 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -44,10 +44,6 @@ first_value = 1 [bumpversion:file:packages/grid/helm/syft/Chart.yaml] -[bumpversion:file:packages/grid/podman/podman-kube/podman-syft-kube.yaml] - -[bumpversion:file:packages/grid/podman/podman-kube/podman-syft-kube-config.yaml] - [bumpversion:file:packages/grid/helm/syft/values.yaml] [bumpversion:file:packages/syftcli/manifest.yml] diff --git a/.github/workflows/cd-syft.yml b/.github/workflows/cd-syft.yml index c153465dd6a..486196ecbdb 100644 --- a/.github/workflows/cd-syft.yml +++ b/.github/workflows/cd-syft.yml @@ -459,7 +459,7 @@ jobs: author_name: ${{ secrets.OM_BOT_NAME }} author_email: ${{ secrets.OM_BOT_EMAIL }} message: "[syft]bump version" - add: "['.bumpversion.cfg', 'VERSION', 'packages/grid/VERSION','packages/syft/PYPI.md', 'packages/grid/devspace.yaml', 'packages/syft/src/syft/VERSION', 'packages/syft/setup.cfg', 'packages/grid/frontend/package.json', 'packages/syft/src/syft/__init__.py', 'packages/grid/helm/syft/Chart.yaml','packages/grid/helm/repo', 'packages/grid/podman/podman-kube/podman-syft-kube.yaml' ,'packages/grid/podman/podman-kube/podman-syft-kube-config.yaml', 'packages/syftcli/manifest.yml', 'packages/syft/src/syft/protocol/protocol_version.json', 'packages/syft/src/syft/protocol/releases/', 'packages/grid/backend/grid/images/worker_cpu.dockerfile','packages/grid/helm/syft/values.yaml','packages/grid/helm/syft']" + add: "['.bumpversion.cfg', 'VERSION', 'packages/grid/VERSION','packages/syft/PYPI.md', 'packages/grid/devspace.yaml', 'packages/syft/src/syft/VERSION', 'packages/syft/setup.cfg', 'packages/grid/frontend/package.json', 'packages/syft/src/syft/__init__.py', 'packages/grid/helm/syft/Chart.yaml','packages/grid/helm/repo', 'packages/syftcli/manifest.yml', 'packages/syft/src/syft/protocol/protocol_version.json', 'packages/syft/src/syft/protocol/releases/', 'packages/grid/backend/grid/images/worker_cpu.dockerfile','packages/grid/helm/syft/values.yaml','packages/grid/helm/syft']" - name: Changes to commit to Syft Repo during stable release if: needs.merge-docker-images.outputs.release_tag == 'latest' diff --git a/.github/workflows/rhel-tests.yml b/.github/workflows/rhel-tests.yml deleted file mode 100644 index 9180635362d..00000000000 --- a/.github/workflows/rhel-tests.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Rhel Podman Stack Tests - -on: - workflow_call: - - workflow_dispatch: - inputs: - none: - description: "Run Version Tests Manually" - required: false - -jobs: - podman-tests-stack: - strategy: - max-parallel: 99 - matrix: - os: [om-ci-rhel-9] - python-version: ["3.12"] - fail-fast: false - - runs-on: ${{matrix.os}} - - steps: - - name: set permissions on work folder for self-runners - run: | - sudo chown -R $USER:$USER ~/actions-runner/_work/ - - - uses: actions/checkout@v4 - - - name: check python version - run: | - python${{matrix.python-version}} --version - - # - name: Check for file changes - # uses: dorny/paths-filter@v2 - # id: changes - # with: - # base: ${{ github.ref }} - # token: ${{ github.token }} - # filters: .github/file-filters.yml - - - name: Install tox - # if: steps.changes.outputs.stack == 'true' - run: | - pip${{matrix.python-version}} install -U tox - - - name: Run notebook tests - #if: steps.changes.outputs.stack == 'true' - run: | - tox -e stack.test.podman diff --git a/README.md b/README.md index 6a02379e67a..2a68d0d07ce 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Perform data science on `data` that remains in `someone else's` server # Quickstart -βœ… `Linux` βœ… `macOS` βœ… `Windows` βœ… `Docker` βœ… `Podman` βœ… `Kubernetes` +βœ… `Linux` βœ… `macOS` βœ… `Windows` βœ… `Docker` βœ… `Kubernetes` ## Install Client @@ -122,7 +122,7 @@ helm install ... --set ingress.class="gce" # Install Notes - PySyft 0.8.1 Requires: 🐍 `python 3.10 - 3.12` - Run: `pip install -U syft` -- PyGrid Requires: 🐳 `docker`, 🦦 `podman` or ☸️ `kubernetes` +- PyGrid Requires: 🐳 `docker` or ☸️ `kubernetes` # Versions diff --git a/packages/grid/podman/podman-kube/podman-syft-kube-config.yaml b/packages/grid/podman/podman-kube/podman-syft-kube-config.yaml deleted file mode 100644 index 079b81e15e4..00000000000 --- a/packages/grid/podman/podman-kube/podman-syft-kube-config.yaml +++ /dev/null @@ -1,104 +0,0 @@ -apiVersion: v1 -kind: ConfigMap -metadata: - name: podman-syft-config -data: - #!/bin/bash - DOMAIN: localhost - NODE_NAME: default_node_name - NODE_TYPE: domain - FRONTEND_TARGET: grid-ui-production - HTTP_PORT: 80 - HTTPS_PORT: 443 - NETWORK_NAME: omnet - RELEASE: production - - # tls - IGNORE_TLS_ERRORS: False - TRAEFIK_TLS_CONF: ./traefik/dynamic-configurations - TRAEFIK_TLS_CERTS: ./traefik/certs - TRAEFIK_PUBLIC_NETWORK: traefik-public - TRAEFIK_TAG: grid.openmined.org - TRAEFIK_PUBLIC_TAG: traefik-public - - STACK_NAME: grid-openmined-org - DOCKER_IMAGE_BACKEND: openmined/grid-backend - DOCKER_IMAGE_FRONTEND: openmined/grid-frontend - DOCKER_IMAGE_SEAWEEDFS: openmined/grid-seaweedfs - DOCKER_IMAGE_TRAEFIK: traefik - TRAEFIK_VERSION: v2.11.0 - REDIS_VERSION: 6.2 - RABBITMQ_VERSION: 3 - VERSION: 0.8.7-beta.7 - VERSION_HASH: unknown - STACK_API_KEY: "" - - # Backend - BACKEND_CORS_ORIGINS: '["http://localhost","http://localhost:4200","http://localhost:3000","http://localhost:8080","https://localhost","https://localhost:4200","https://localhost:3000","https://localhost:8080","http://dev.grid.openmined.org","https://stag.grid.openmined.org","https://grid.openmined.org"]' - PROJECT_NAME: grid - SECRET_KEY: changethis - DEFAULT_ROOT_EMAIL: info@openmined.org - DEFAULT_ROOT_PASSWORD: changethis - SMTP_TLS: True - SMTP_PORT: 587 - SMTP_HOST: - SMTP_USER: - SMTP_PASSWORD: - EMAILS_FROM_EMAIL: info@openmined.org - SERVER_HOST: "https://${DOMAIN}" - NETWORK_CHECK_INTERVAL: 60 - DOMAIN_CHECK_INTERVAL: 60 - ASSOCIATION_TIMEOUT: 10 - USERS_OPEN_REGISTRATION: False - DEV_MODE: False - - # New Service Flag - USE_NEW_SERVICE: False - - # Frontend - BACKEND_API_BASE_URL: "/api/v2" - - # SeaweedFS - S3_ENDPOINT: "seaweedfs" - S3_PORT: 8333 - S3_ROOT_USER: "admin" - S3_ROOT_PWD: "admin" - S3_REGION: "us-east-1" - S3_PRESIGNED_TIMEOUT_SECS: 1800 - - # Jax - JAX_ENABLE_X64: True - - # Mongo - MONGO_HOST: localhost - MONGO_PORT: 27017 - MONGO_USERNAME: root - MONGO_PASSWORD: example - MONGO_INITDB_ROOT_USERNAME: root - MONGO_INITDB_ROOT_PASSWORD: example - - # Redis - REDIS_PORT: 6379 - REDIS_STORE_DB_ID: 0 - REDIS_LEDGER_DB_ID: 1 - REDIS_HOST: redis - - # System - CONTAINER_HOST: podman - RELATIVE_PATH: "" - - # Jaeger - TRACE: False - JAEGER_HOST: localhost - JAEGER_PORT: 14268 - - # Syft - SYFT_TUTORIAL_MODE: False - CREDENTIALS_VOLUME: credentials-data - NODE_SIDE_TYPE: high - - # Worker - USE_BLOB_STORAGE: False - - # Registation - ENABLE_SIGNUP: False diff --git a/packages/grid/podman/podman-kube/podman-syft-kube.yaml b/packages/grid/podman/podman-kube/podman-syft-kube.yaml deleted file mode 100644 index 6c639bec7b8..00000000000 --- a/packages/grid/podman/podman-kube/podman-syft-kube.yaml +++ /dev/null @@ -1,92 +0,0 @@ -# Save the output of this file and use kubectl create -f to import -# it into Kubernetes. -# -# Created with podman-4.4.1 -apiVersion: v1 -kind: Pod -metadata: - annotations: - bind-mount-options: ./traefik:Z - creationTimestamp: "2023-07-28T10:22:55Z" - labels: - app: syft - name: syft -spec: - containers: - - name: mongo-db - args: - - mongod - env: - - name: MONGO_INITDB_ROOT_USERNAME - value: root - - name: MONGO_INITDB_ROOT_PASSWORD - value: example - image: docker.io/library/mongo:7.0.4 - imagePullPolicy: IfNotPresent - resources: {} - tty: true - volumeMounts: - - mountPath: /data/configdb - name: f1b3ce32d0fb1a523f83e89dbd0446a37a8609c85507deaaba0567f98155d84b-pvc - - mountPath: /data/db - name: 89196523be4d26c2ec522a40974fd101abd2fc1ec608db27ad40758cc2b52215-pvc - - - name: backend - env: - - name: PORT - value: "8001" - - name: ENABLE_WARNINGS - value: "False" - envFrom: - - configMapRef: - name: podman-syft-config - - image: docker.io/openmined/grid-backend:0.8.7-beta.7 - imagePullPolicy: IfNotPresent - resources: {} - tty: true - - - name: frontend - args: - - /bin/sh - - -c - - pnpm dev - env: - - name: PORT - value: "80" - envFrom: - - configMapRef: - name: podman-syft-config - image: docker.io/openmined/grid-frontend:0.8.7-beta.7 - imagePullPolicy: IfNotPresent - resources: {} - tty: true - - - name: traefik - ports: - - containerPort: 81 - hostPort: 8080 - args: - - --configFile=/traefik_config/traefik.yml - image: docker.io/library/traefik:v2.8.1 - imagePullPolicy: IfNotPresent - resources: {} - tty: true - volumeMounts: - - mountPath: /traefik_config - name: traefik-host-0 - readOnly: true - hostname: syft - restartPolicy: Always - volumes: - - name: f1b3ce32d0fb1a523f83e89dbd0446a37a8609c85507deaaba0567f98155d84b-pvc - persistentVolumeClaim: - claimName: f1b3ce32d0fb1a523f83e89dbd0446a37a8609c85507deaaba0567f98155d84b - - name: 89196523be4d26c2ec522a40974fd101abd2fc1ec608db27ad40758cc2b52215-pvc - persistentVolumeClaim: - claimName: 89196523be4d26c2ec522a40974fd101abd2fc1ec608db27ad40758cc2b52215 - - hostPath: - path: ./traefik - type: Directory - name: traefik-host-0 -status: {} diff --git a/packages/grid/podman/podman-kube/traefik/conf/dynamic.yml b/packages/grid/podman/podman-kube/traefik/conf/dynamic.yml deleted file mode 100644 index 4d8e61900ce..00000000000 --- a/packages/grid/podman/podman-kube/traefik/conf/dynamic.yml +++ /dev/null @@ -1,28 +0,0 @@ -#since the containers are in the same pod, they could communicate using localhost - -http: - services: - frontend: - loadBalancer: - servers: - - url: "http://localhost:80" - backend: - loadBalancer: - servers: - - url: "http://localhost:8001" - routers: - frontend: - rule: "PathPrefix(`/`)" - entryPoints: - - web - service: "frontend" - backend: - rule: "PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)" - entryPoints: - - web - service: "backend" - ping: - rule: "PathPrefix(`/ping`)" - entryPoints: - - web - service: "ping@internal" diff --git a/packages/grid/podman/podman-kube/traefik/traefik.yml b/packages/grid/podman/podman-kube/traefik/traefik.yml deleted file mode 100644 index 4e2f3434049..00000000000 --- a/packages/grid/podman/podman-kube/traefik/traefik.yml +++ /dev/null @@ -1,18 +0,0 @@ -global: - checkNewVersion: false - sendAnonymousUsage: false - -log: - level: INFO - -entryPoints: - web: - address: :81 - -ping: - manualRouting: true - -providers: - file: - directory: /traefik_config/conf - watch: true diff --git a/packages/syftcli/manifest.yml b/packages/syftcli/manifest.yml index cd0ff802c10..a2224cec8a2 100644 --- a/packages/syftcli/manifest.yml +++ b/packages/syftcli/manifest.yml @@ -24,8 +24,3 @@ configFiles: - packages/grid/traefik/docker/traefik.yml k8s: - packages/grid/devspace.yaml - podman: - - packages/grid/podman/podman-kube/podman-syft-kube-config.yaml - - packages/grid/podman/podman-kube/podman-syft-kube.yaml - - packages/grid/podman/podman-kube/traefik/conf/dynamic.yml - - packages/grid/podman/podman-kube/traefik/traefik.yml diff --git a/tox.ini b/tox.ini index 5aa24441f8e..daa0fb53ebc 100644 --- a/tox.ini +++ b/tox.ini @@ -20,8 +20,6 @@ envlist = single_container.destroy stack.test.notebook stack.test.integration.k8s - stack.test.vm - stack.test.podman frontend.test.unit frontend.test.e2e frontend.generate.types @@ -357,38 +355,6 @@ commands = -[testenv:stack.test.podman] -description = Stack podman Tests for Rhel & Centos -deps = - {[testenv:syft]deps} - nbmake -allowlist_externals = - cd - vagrant - bash -changedir = {toxinidir} -setenv = - ORCHESTRA_DEPLOYMENT_TYPE = {env:ORCHESTRA_DEPLOYMENT_TYPE:podman} - NODE_PORT = {env:NODE_PORT:8080} -commands = - python -c 'import syft as sy; sy.stage_protocol_changes()' - bash -c "podman pod rm --force --all || true"; - bash -c "podman system prune --volumes --force || true"; - bash -c "podman volume rm $(podman volume ls -q)||true"; - - # Force Removal of images - bash -c "podman image prune --all --force || true"; - - # Build Backend Image - bash -c "SYFT_VERSION=$(python packages/grid/VERSION) && podman build -t docker.io/openmined/grid-backend:$SYFT_VERSION -f packages/grid/backend/backend.dockerfile --target backend packages"; - - # Build Frontend Image - bash -c "SYFT_VERSION=$(python packages/grid/VERSION) && podman build -t docker.io/openmined/grid-frontend:$SYFT_VERSION -f packages/grid/frontend/frontend.dockerfile --target grid-ui-development packages/grid/frontend"; - - bash -c 'cd packages/grid/podman/podman-kube && podman play kube podman-syft-kube.yaml --configmap=podman-syft-kube-config.yaml' - bash -c '(podman logs -f syft-backend &) | grep -q "Application startup complete" || true' - pytest -x --nbmake --nbmake-timeout=1000 notebooks/api/0.8 -p no:randomly -vvvv - [testenv:frontend.generate.types] description = Generate Types for Frontend deps = From 5c7323f7ddb95e3e044ea51c3c2fef99ace148fd Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:10:56 +0530 Subject: [PATCH 07/15] removed vm test suites --- .github/workflows/vm-tests.yml | 78 ---------------------------------- 1 file changed, 78 deletions(-) delete mode 100644 .github/workflows/vm-tests.yml diff --git a/.github/workflows/vm-tests.yml b/.github/workflows/vm-tests.yml deleted file mode 100644 index be07b4a42a3..00000000000 --- a/.github/workflows/vm-tests.yml +++ /dev/null @@ -1,78 +0,0 @@ -name: VM Tests - Stack - -on: - workflow_call: - - # pull_request: - # branches: - # - dev - # - main - # - "0.8" - - workflow_dispatch: - inputs: - none: - description: "Run Version Tests Manually" - required: false - -jobs: - vm-tests-stack: - strategy: - max-parallel: 99 - matrix: - os: [macos-12] - python-version: ["3.12"] - deployment-type: ["vm"] - fail-fast: false - - runs-on: ${{matrix.os}} - - steps: - - uses: actions/checkout@v4 - - - name: Check for file changes - uses: dorny/paths-filter@v3 - id: changes - with: - base: ${{ github.ref }} - token: ${{ github.token }} - filters: .github/file-filters.yml - - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 - if: steps.changes.outputs.stack == 'true' - with: - python-version: ${{ matrix.python-version }} - - - name: Get pip cache dir - if: steps.changes.outputs.stack == 'true' - id: pip-cache - shell: bash - run: | - echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT - - - name: pip cache - uses: actions/cache@v4 - if: steps.changes.outputs.stack == 'true' - with: - path: ${{ steps.pip-cache.outputs.dir }} - key: ${{ runner.os }}-pip-py${{ matrix.python-version }} - restore-keys: | - ${{ runner.os }}-pip-py${{ matrix.python-version }} - - - name: Upgrade pip - if: steps.changes.outputs.stack == 'true' - run: | - python -m pip install --upgrade --user pip - - - name: Install tox - if: steps.changes.outputs.stack == 'true' - run: | - pip install -U tox - - - name: Run notebook tests - if: steps.changes.outputs.stack == 'true' - env: - ORCHESTRA_DEPLOYMENT_TYPE: "${{ matrix.deployment-type }}" - run: | - tox -e stack.test.vm From 863e1300d70f8eac7b5d5c96ca3cede3dc3873e5 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:12:01 +0530 Subject: [PATCH 08/15] remove rabbitmq conf --- packages/grid/rabbitmq/rabbitmq.conf | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 packages/grid/rabbitmq/rabbitmq.conf diff --git a/packages/grid/rabbitmq/rabbitmq.conf b/packages/grid/rabbitmq/rabbitmq.conf deleted file mode 100644 index 5eb0c0d8819..00000000000 --- a/packages/grid/rabbitmq/rabbitmq.conf +++ /dev/null @@ -1,3 +0,0 @@ -max_message_size = 536870911 -heartbeat = 600 -loopback_users.guest = true From 4b9752b2a0a2f225fe2ecb02b4044278412cdfd4 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:12:23 +0530 Subject: [PATCH 09/15] removed redis folder --- packages/grid/redis/redis.conf | 2051 -------------------------------- 1 file changed, 2051 deletions(-) delete mode 100644 packages/grid/redis/redis.conf diff --git a/packages/grid/redis/redis.conf b/packages/grid/redis/redis.conf deleted file mode 100644 index 8a486c47104..00000000000 --- a/packages/grid/redis/redis.conf +++ /dev/null @@ -1,2051 +0,0 @@ -# Redis configuration file example. -# -# Note that in order to read the configuration file, Redis must be -# started with the file path as first argument: -# -# ./redis-server /path/to/redis.conf - -# Note on units: when memory size is needed, it is possible to specify -# it in the usual form of 1k 5GB 4M and so forth: -# -# 1k => 1000 bytes -# 1kb => 1024 bytes -# 1m => 1000000 bytes -# 1mb => 1024*1024 bytes -# 1g => 1000000000 bytes -# 1gb => 1024*1024*1024 bytes -# -# units are case insensitive so 1GB 1Gb 1gB are all the same. - -################################## INCLUDES ################################### - -# Include one or more other config files here. This is useful if you -# have a standard template that goes to all Redis servers but also need -# to customize a few per-server settings. Include files can include -# other files, so use this wisely. -# -# Note that option "include" won't be rewritten by command "CONFIG REWRITE" -# from admin or Redis Sentinel. Since Redis always uses the last processed -# line as value of a configuration directive, you'd better put includes -# at the beginning of this file to avoid overwriting config change at runtime. -# -# If instead you are interested in using includes to override configuration -# options, it is better to use include as the last line. -# -# include /path/to/local.conf -# include /path/to/other.conf - -################################## MODULES ##################################### - -# Load modules at startup. If the server is not able to load modules -# it will abort. It is possible to use multiple loadmodule directives. -# -# loadmodule /path/to/my_module.so -# loadmodule /path/to/other_module.so - -################################## NETWORK ##################################### - -# By default, if no "bind" configuration directive is specified, Redis listens -# for connections from all available network interfaces on the host machine. -# It is possible to listen to just one or multiple selected interfaces using -# the "bind" configuration directive, followed by one or more IP addresses. -# Each address can be prefixed by "-", which means that redis will not fail to -# start if the address is not available. Being not available only refers to -# addresses that does not correspond to any network interfece. Addresses that -# are already in use will always fail, and unsupported protocols will always BE -# silently skipped. -# -# Examples: -# -# bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses -# bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6 -# bind * -::* # like the default, all available interfaces -# -# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the -# internet, binding to all the interfaces is dangerous and will expose the -# instance to everybody on the internet. So by default we uncomment the -# following bind directive, that will force Redis to listen only on the -# IPv4 and IPv6 (if available) loopback interface addresses (this means Redis -# will only be able to accept client connections from the same host that it is -# running on). -# -# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES -# JUST COMMENT OUT THE FOLLOWING LINE. -# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -bind 127.0.0.1 -::1 - -# Protected mode is a layer of security protection, in order to avoid that -# Redis instances left open on the internet are accessed and exploited. -# -# When protected mode is on and if: -# -# 1) The server is not binding explicitly to a set of addresses using the -# "bind" directive. -# 2) No password is configured. -# -# The server only accepts connections from clients connecting from the -# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain -# sockets. -# -# By default protected mode is enabled. You should disable it only if -# you are sure you want clients from other hosts to connect to Redis -# even if no authentication is configured, nor a specific set of interfaces -# are explicitly listed using the "bind" directive. -protected-mode yes - -# Accept connections on the specified port, default is 6379 (IANA #815344). -# If port 0 is specified Redis will not listen on a TCP socket. -port 6379 - -# TCP listen() backlog. -# -# In high requests-per-second environments you need a high backlog in order -# to avoid slow clients connection issues. Note that the Linux kernel -# will silently truncate it to the value of /proc/sys/net/core/somaxconn so -# make sure to raise both the value of somaxconn and tcp_max_syn_backlog -# in order to get the desired effect. -tcp-backlog 511 - -# Unix socket. -# -# Specify the path for the Unix socket that will be used to listen for -# incoming connections. There is no default, so Redis will not listen -# on a unix socket when not specified. -# -# unixsocket /run/redis.sock -# unixsocketperm 700 - -# Close the connection after a client is idle for N seconds (0 to disable) -timeout 0 - -# TCP keepalive. -# -# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence -# of communication. This is useful for two reasons: -# -# 1) Detect dead peers. -# 2) Force network equipment in the middle to consider the connection to be -# alive. -# -# On Linux, the specified value (in seconds) is the period used to send ACKs. -# Note that to close the connection the double of the time is needed. -# On other kernels the period depends on the kernel configuration. -# -# A reasonable value for this option is 300 seconds, which is the new -# Redis default starting with Redis 3.2.1. -tcp-keepalive 300 - -################################# TLS/SSL ##################################### - -# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration -# directive can be used to define TLS-listening ports. To enable TLS on the -# default port, use: -# -# port 0 -# tls-port 6379 - -# Configure a X.509 certificate and private key to use for authenticating the -# server to connected clients, masters or cluster peers. These files should be -# PEM formatted. -# -# tls-cert-file redis.crt -# tls-key-file redis.key -# -# If the key file is encrypted using a passphrase, it can be included here -# as well. -# -# tls-key-file-pass secret - -# Normally Redis uses the same certificate for both server functions (accepting -# connections) and client functions (replicating from a master, establishing -# cluster bus connections, etc.). -# -# Sometimes certificates are issued with attributes that designate them as -# client-only or server-only certificates. In that case it may be desired to use -# different certificates for incoming (server) and outgoing (client) -# connections. To do that, use the following directives: -# -# tls-client-cert-file client.crt -# tls-client-key-file client.key -# -# If the key file is encrypted using a passphrase, it can be included here -# as well. -# -# tls-client-key-file-pass secret - -# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange: -# -# tls-dh-params-file redis.dh - -# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL -# clients and peers. Redis requires an explicit configuration of at least one -# of these, and will not implicitly use the system wide configuration. -# -# tls-ca-cert-file ca.crt -# tls-ca-cert-dir /etc/ssl/certs - -# By default, clients (including replica servers) on a TLS port are required -# to authenticate using valid client side certificates. -# -# If "no" is specified, client certificates are not required and not accepted. -# If "optional" is specified, client certificates are accepted and must be -# valid if provided, but are not required. -# -# tls-auth-clients no -# tls-auth-clients optional - -# By default, a Redis replica does not attempt to establish a TLS connection -# with its master. -# -# Use the following directive to enable TLS on replication links. -# -# tls-replication yes - -# By default, the Redis Cluster bus uses a plain TCP connection. To enable -# TLS for the bus protocol, use the following directive: -# -# tls-cluster yes - -# By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended -# that older formally deprecated versions are kept disabled to reduce the attack surface. -# You can explicitly specify TLS versions to support. -# Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2", -# "TLSv1.3" (OpenSSL >= 1.1.1) or any combination. -# To enable only TLSv1.2 and TLSv1.3, use: -# -# tls-protocols "TLSv1.2 TLSv1.3" - -# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information -# about the syntax of this string. -# -# Note: this configuration applies only to <= TLSv1.2. -# -# tls-ciphers DEFAULT:!MEDIUM - -# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more -# information about the syntax of this string, and specifically for TLSv1.3 -# ciphersuites. -# -# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 - -# When choosing a cipher, use the server's preference instead of the client -# preference. By default, the server follows the client's preference. -# -# tls-prefer-server-ciphers yes - -# By default, TLS session caching is enabled to allow faster and less expensive -# reconnections by clients that support it. Use the following directive to disable -# caching. -# -# tls-session-caching no - -# Change the default number of TLS sessions cached. A zero value sets the cache -# to unlimited size. The default size is 20480. -# -# tls-session-cache-size 5000 - -# Change the default timeout of cached TLS sessions. The default timeout is 300 -# seconds. -# -# tls-session-cache-timeout 60 - -################################# GENERAL ##################################### - -# By default Redis does not run as a daemon. Use 'yes' if you need it. -# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. -# When Redis is supervised by upstart or systemd, this parameter has no impact. -daemonize no - -# If you run Redis from upstart or systemd, Redis can interact with your -# supervision tree. Options: -# supervised no - no supervision interaction -# supervised upstart - signal upstart by putting Redis into SIGSTOP mode -# requires "expect stop" in your upstart job config -# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET -# on startup, and updating Redis status on a regular -# basis. -# supervised auto - detect upstart or systemd method based on -# UPSTART_JOB or NOTIFY_SOCKET environment variables -# Note: these supervision methods only signal "process is ready." -# They do not enable continuous pings back to your supervisor. -# -# The default is "no". To run under upstart/systemd, you can simply uncomment -# the line below: -# -# supervised auto - -# If a pid file is specified, Redis writes it where specified at startup -# and removes it at exit. -# -# When the server runs non daemonized, no pid file is created if none is -# specified in the configuration. When the server is daemonized, the pid file -# is used even if not specified, defaulting to "/var/run/redis.pid". -# -# Creating a pid file is best effort: if Redis is not able to create it -# nothing bad happens, the server will start and run normally. -# -# Note that on modern Linux systems "/run/redis.pid" is more conforming -# and should be used instead. -pidfile /var/run/redis_6379.pid - -# Specify the server verbosity level. -# This can be one of: -# debug (a lot of information, useful for development/testing) -# verbose (many rarely useful info, but not a mess like the debug level) -# notice (moderately verbose, what you want in production probably) -# warning (only very important / critical messages are logged) -loglevel notice - -# Specify the log file name. Also the empty string can be used to force -# Redis to log on the standard output. Note that if you use standard -# output for logging but daemonize, logs will be sent to /dev/null -logfile "" - -# To enable logging to the system logger, just set 'syslog-enabled' to yes, -# and optionally update the other syslog parameters to suit your needs. -# syslog-enabled no - -# Specify the syslog identity. -# syslog-ident redis - -# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. -# syslog-facility local0 - -# To disable the built in crash log, which will possibly produce cleaner core -# dumps when they are needed, uncomment the following: -# -# crash-log-enabled no - -# To disable the fast memory check that's run as part of the crash log, which -# will possibly let redis terminate sooner, uncomment the following: -# -# crash-memcheck-enabled no - -# Set the number of databases. The default database is DB 0, you can select -# a different one on a per-connection basis using SELECT where -# dbid is a number between 0 and 'databases'-1 -databases 16 - -# By default Redis shows an ASCII art logo only when started to log to the -# standard output and if the standard output is a TTY and syslog logging is -# disabled. Basically this means that normally a logo is displayed only in -# interactive sessions. -# -# However it is possible to force the pre-4.0 behavior and always show a -# ASCII art logo in startup logs by setting the following option to yes. -always-show-logo no - -# By default, Redis modifies the process title (as seen in 'top' and 'ps') to -# provide some runtime information. It is possible to disable this and leave -# the process name as executed by setting the following to no. -set-proc-title yes - -# When changing the process title, Redis uses the following template to construct -# the modified title. -# -# Template variables are specified in curly brackets. The following variables are -# supported: -# -# {title} Name of process as executed if parent, or type of child process. -# {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or -# Unix socket if only that's available. -# {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]". -# {port} TCP port listening on, or 0. -# {tls-port} TLS port listening on, or 0. -# {unixsocket} Unix domain socket listening on, or "". -# {config-file} Name of configuration file used. -# -proc-title-template "{title} {listen-addr} {server-mode}" - -################################ SNAPSHOTTING ################################ - -# Save the DB to disk. -# -# save -# -# Redis will save the DB if both the given number of seconds and the given -# number of write operations against the DB occurred. -# -# Snapshotting can be completely disabled with a single empty string argument -# as in following example: -# -# save "" -# -# Unless specified otherwise, by default Redis will save the DB: -# * After 3600 seconds (an hour) if at least 1 key changed -# * After 300 seconds (5 minutes) if at least 100 keys changed -# * After 60 seconds if at least 10000 keys changed -# -# You can set these explicitly by uncommenting the three following lines. -# -# save 3600 1 -# save 300 100 -# save 60 10000 - -# By default Redis will stop accepting writes if RDB snapshots are enabled -# (at least one save point) and the latest background save failed. -# This will make the user aware (in a hard way) that data is not persisting -# on disk properly, otherwise chances are that no one will notice and some -# disaster will happen. -# -# If the background saving process will start working again Redis will -# automatically allow writes again. -# -# However if you have setup your proper monitoring of the Redis server -# and persistence, you may want to disable this feature so that Redis will -# continue to work as usual even if there are problems with disk, -# permissions, and so forth. -stop-writes-on-bgsave-error yes - -# Compress string objects using LZF when dump .rdb databases? -# By default compression is enabled as it's almost always a win. -# If you want to save some CPU in the saving child set it to 'no' but -# the dataset will likely be bigger if you have compressible values or keys. -rdbcompression yes - -# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. -# This makes the format more resistant to corruption but there is a performance -# hit to pay (around 10%) when saving and loading RDB files, so you can disable it -# for maximum performances. -# -# RDB files created with checksum disabled have a checksum of zero that will -# tell the loading code to skip the check. -rdbchecksum yes - -# Enables or disables full sanitation checks for ziplist and listpack etc when -# loading an RDB or RESTORE payload. This reduces the chances of a assertion or -# crash later on while processing commands. -# Options: -# no - Never perform full sanitation -# yes - Always perform full sanitation -# clients - Perform full sanitation only for user connections. -# Excludes: RDB files, RESTORE commands received from the master -# connection, and client connections which have the -# skip-sanitize-payload ACL flag. -# The default should be 'clients' but since it currently affects cluster -# resharding via MIGRATE, it is temporarily set to 'no' by default. -# -# sanitize-dump-payload no - -# The filename where to dump the DB -dbfilename dump.rdb - -# Remove RDB files used by replication in instances without persistence -# enabled. By default this option is disabled, however there are environments -# where for regulations or other security concerns, RDB files persisted on -# disk by masters in order to feed replicas, or stored on disk by replicas -# in order to load them for the initial synchronization, should be deleted -# ASAP. Note that this option ONLY WORKS in instances that have both AOF -# and RDB persistence disabled, otherwise is completely ignored. -# -# An alternative (and sometimes better) way to obtain the same effect is -# to use diskless replication on both master and replicas instances. However -# in the case of replicas, diskless is not always an option. -rdb-del-sync-files no - -# The working directory. -# -# The DB will be written inside this directory, with the filename specified -# above using the 'dbfilename' configuration directive. -# -# The Append Only File will also be created inside this directory. -# -# Note that you must specify a directory here, not a file name. -dir ./ - -################################# REPLICATION ################################# - -# Master-Replica replication. Use replicaof to make a Redis instance a copy of -# another Redis server. A few things to understand ASAP about Redis replication. -# -# +------------------+ +---------------+ -# | Master | ---> | Replica | -# | (receive writes) | | (exact copy) | -# +------------------+ +---------------+ -# -# 1) Redis replication is asynchronous, but you can configure a master to -# stop accepting writes if it appears to be not connected with at least -# a given number of replicas. -# 2) Redis replicas are able to perform a partial resynchronization with the -# master if the replication link is lost for a relatively small amount of -# time. You may want to configure the replication backlog size (see the next -# sections of this file) with a sensible value depending on your needs. -# 3) Replication is automatic and does not need user intervention. After a -# network partition replicas automatically try to reconnect to masters -# and resynchronize with them. -# -# replicaof - -# If the master is password protected (using the "requirepass" configuration -# directive below) it is possible to tell the replica to authenticate before -# starting the replication synchronization process, otherwise the master will -# refuse the replica request. -# -# masterauth -# -# However this is not enough if you are using Redis ACLs (for Redis version -# 6 or greater), and the default user is not capable of running the PSYNC -# command and/or other commands needed for replication. In this case it's -# better to configure a special user to use with replication, and specify the -# masteruser configuration as such: -# -# masteruser -# -# When masteruser is specified, the replica will authenticate against its -# master using the new AUTH form: AUTH . - -# When a replica loses its connection with the master, or when the replication -# is still in progress, the replica can act in two different ways: -# -# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will -# still reply to client requests, possibly with out of date data, or the -# data set may just be empty if this is the first synchronization. -# -# 2) If replica-serve-stale-data is set to 'no' the replica will reply with -# an error "SYNC with master in progress" to all commands except: -# INFO, REPLICAOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE, -# UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST, -# HOST and LATENCY. -# -replica-serve-stale-data yes - -# You can configure a replica instance to accept writes or not. Writing against -# a replica instance may be useful to store some ephemeral data (because data -# written on a replica will be easily deleted after resync with the master) but -# may also cause problems if clients are writing to it because of a -# misconfiguration. -# -# Since Redis 2.6 by default replicas are read-only. -# -# Note: read only replicas are not designed to be exposed to untrusted clients -# on the internet. It's just a protection layer against misuse of the instance. -# Still a read only replica exports by default all the administrative commands -# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve -# security of read only replicas using 'rename-command' to shadow all the -# administrative / dangerous commands. -replica-read-only yes - -# Replication SYNC strategy: disk or socket. -# -# New replicas and reconnecting replicas that are not able to continue the -# replication process just receiving differences, need to do what is called a -# "full synchronization". An RDB file is transmitted from the master to the -# replicas. -# -# The transmission can happen in two different ways: -# -# 1) Disk-backed: The Redis master creates a new process that writes the RDB -# file on disk. Later the file is transferred by the parent -# process to the replicas incrementally. -# 2) Diskless: The Redis master creates a new process that directly writes the -# RDB file to replica sockets, without touching the disk at all. -# -# With disk-backed replication, while the RDB file is generated, more replicas -# can be queued and served with the RDB file as soon as the current child -# producing the RDB file finishes its work. With diskless replication instead -# once the transfer starts, new replicas arriving will be queued and a new -# transfer will start when the current one terminates. -# -# When diskless replication is used, the master waits a configurable amount of -# time (in seconds) before starting the transfer in the hope that multiple -# replicas will arrive and the transfer can be parallelized. -# -# With slow disks and fast (large bandwidth) networks, diskless replication -# works better. -repl-diskless-sync no - -# When diskless replication is enabled, it is possible to configure the delay -# the server waits in order to spawn the child that transfers the RDB via socket -# to the replicas. -# -# This is important since once the transfer starts, it is not possible to serve -# new replicas arriving, that will be queued for the next RDB transfer, so the -# server waits a delay in order to let more replicas arrive. -# -# The delay is specified in seconds, and by default is 5 seconds. To disable -# it entirely just set it to 0 seconds and the transfer will start ASAP. -repl-diskless-sync-delay 5 - -# ----------------------------------------------------------------------------- -# WARNING: RDB diskless load is experimental. Since in this setup the replica -# does not immediately store an RDB on disk, it may cause data loss during -# failovers. RDB diskless load + Redis modules not handling I/O reads may also -# cause Redis to abort in case of I/O errors during the initial synchronization -# stage with the master. Use only if you know what you are doing. -# ----------------------------------------------------------------------------- -# -# Replica can load the RDB it reads from the replication link directly from the -# socket, or store the RDB to a file and read that file after it was completely -# received from the master. -# -# In many cases the disk is slower than the network, and storing and loading -# the RDB file may increase replication time (and even increase the master's -# Copy on Write memory and salve buffers). -# However, parsing the RDB file directly from the socket may mean that we have -# to flush the contents of the current database before the full rdb was -# received. For this reason we have the following options: -# -# "disabled" - Don't use diskless load (store the rdb file to the disk first) -# "on-empty-db" - Use diskless load only when it is completely safe. -# "swapdb" - Keep a copy of the current db contents in RAM while parsing -# the data directly from the socket. note that this requires -# sufficient memory, if you don't have it, you risk an OOM kill. -repl-diskless-load disabled - -# Replicas send PINGs to server in a predefined interval. It's possible to -# change this interval with the repl_ping_replica_period option. The default -# value is 10 seconds. -# -# repl-ping-replica-period 10 - -# The following option sets the replication timeout for: -# -# 1) Bulk transfer I/O during SYNC, from the point of view of replica. -# 2) Master timeout from the point of view of replicas (data, pings). -# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). -# -# It is important to make sure that this value is greater than the value -# specified for repl-ping-replica-period otherwise a timeout will be detected -# every time there is low traffic between the master and the replica. The default -# value is 60 seconds. -# -# repl-timeout 60 - -# Disable TCP_NODELAY on the replica socket after SYNC? -# -# If you select "yes" Redis will use a smaller number of TCP packets and -# less bandwidth to send data to replicas. But this can add a delay for -# the data to appear on the replica side, up to 40 milliseconds with -# Linux kernels using a default configuration. -# -# If you select "no" the delay for data to appear on the replica side will -# be reduced but more bandwidth will be used for replication. -# -# By default we optimize for low latency, but in very high traffic conditions -# or when the master and replicas are many hops away, turning this to "yes" may -# be a good idea. -repl-disable-tcp-nodelay no - -# Set the replication backlog size. The backlog is a buffer that accumulates -# replica data when replicas are disconnected for some time, so that when a -# replica wants to reconnect again, often a full resync is not needed, but a -# partial resync is enough, just passing the portion of data the replica -# missed while disconnected. -# -# The bigger the replication backlog, the longer the replica can endure the -# disconnect and later be able to perform a partial resynchronization. -# -# The backlog is only allocated if there is at least one replica connected. -# -# repl-backlog-size 1mb - -# After a master has no connected replicas for some time, the backlog will be -# freed. The following option configures the amount of seconds that need to -# elapse, starting from the time the last replica disconnected, for the backlog -# buffer to be freed. -# -# Note that replicas never free the backlog for timeout, since they may be -# promoted to masters later, and should be able to correctly "partially -# resynchronize" with other replicas: hence they should always accumulate backlog. -# -# A value of 0 means to never release the backlog. -# -# repl-backlog-ttl 3600 - -# The replica priority is an integer number published by Redis in the INFO -# output. It is used by Redis Sentinel in order to select a replica to promote -# into a master if the master is no longer working correctly. -# -# A replica with a low priority number is considered better for promotion, so -# for instance if there are three replicas with priority 10, 100, 25 Sentinel -# will pick the one with priority 10, that is the lowest. -# -# However a special priority of 0 marks the replica as not able to perform the -# role of master, so a replica with priority of 0 will never be selected by -# Redis Sentinel for promotion. -# -# By default the priority is 100. -replica-priority 100 - -# ----------------------------------------------------------------------------- -# By default, Redis Sentinel includes all replicas in its reports. A replica -# can be excluded from Redis Sentinel's announcements. An unannounced replica -# will be ignored by the 'sentinel replicas ' command and won't be -# exposed to Redis Sentinel's clients. -# -# This option does not change the behavior of replica-priority. Even with -# replica-announced set to 'no', the replica can be promoted to master. To -# prevent this behavior, set replica-priority to 0. -# -# replica-announced yes - -# It is possible for a master to stop accepting writes if there are less than -# N replicas connected, having a lag less or equal than M seconds. -# -# The N replicas need to be in "online" state. -# -# The lag in seconds, that must be <= the specified value, is calculated from -# the last ping received from the replica, that is usually sent every second. -# -# This option does not GUARANTEE that N replicas will accept the write, but -# will limit the window of exposure for lost writes in case not enough replicas -# are available, to the specified number of seconds. -# -# For example to require at least 3 replicas with a lag <= 10 seconds use: -# -# min-replicas-to-write 3 -# min-replicas-max-lag 10 -# -# Setting one or the other to 0 disables the feature. -# -# By default min-replicas-to-write is set to 0 (feature disabled) and -# min-replicas-max-lag is set to 10. - -# A Redis master is able to list the address and port of the attached -# replicas in different ways. For example the "INFO replication" section -# offers this information, which is used, among other tools, by -# Redis Sentinel in order to discover replica instances. -# Another place where this info is available is in the output of the -# "ROLE" command of a master. -# -# The listed IP address and port normally reported by a replica is -# obtained in the following way: -# -# IP: The address is auto detected by checking the peer address -# of the socket used by the replica to connect with the master. -# -# Port: The port is communicated by the replica during the replication -# handshake, and is normally the port that the replica is using to -# listen for connections. -# -# However when port forwarding or Network Address Translation (NAT) is -# used, the replica may actually be reachable via different IP and port -# pairs. The following two options can be used by a replica in order to -# report to its master a specific set of IP and port, so that both INFO -# and ROLE will report those values. -# -# There is no need to use both the options if you need to override just -# the port or the IP address. -# -# replica-announce-ip 5.5.5.5 -# replica-announce-port 1234 - -############################### KEYS TRACKING ################################# - -# Redis implements server assisted support for client side caching of values. -# This is implemented using an invalidation table that remembers, using -# a radix key indexed by key name, what clients have which keys. In turn -# this is used in order to send invalidation messages to clients. Please -# check this page to understand more about the feature: -# -# https://redis.io/topics/client-side-caching -# -# When tracking is enabled for a client, all the read only queries are assumed -# to be cached: this will force Redis to store information in the invalidation -# table. When keys are modified, such information is flushed away, and -# invalidation messages are sent to the clients. However if the workload is -# heavily dominated by reads, Redis could use more and more memory in order -# to track the keys fetched by many clients. -# -# For this reason it is possible to configure a maximum fill value for the -# invalidation table. By default it is set to 1M of keys, and once this limit -# is reached, Redis will start to evict keys in the invalidation table -# even if they were not modified, just to reclaim memory: this will in turn -# force the clients to invalidate the cached values. Basically the table -# maximum size is a trade off between the memory you want to spend server -# side to track information about who cached what, and the ability of clients -# to retain cached objects in memory. -# -# If you set the value to 0, it means there are no limits, and Redis will -# retain as many keys as needed in the invalidation table. -# In the "stats" INFO section, you can find information about the number of -# keys in the invalidation table at every given moment. -# -# Note: when key tracking is used in broadcasting mode, no memory is used -# in the server side so this setting is useless. -# -# tracking-table-max-keys 1000000 - -################################## SECURITY ################################### - -# Warning: since Redis is pretty fast, an outside user can try up to -# 1 million passwords per second against a modern box. This means that you -# should use very strong passwords, otherwise they will be very easy to break. -# Note that because the password is really a shared secret between the client -# and the server, and should not be memorized by any human, the password -# can be easily a long string from /dev/urandom or whatever, so by using a -# long and unguessable password no brute force attack will be possible. - -# Redis ACL users are defined in the following format: -# -# user ... acl rules ... -# -# For example: -# -# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 -# -# The special username "default" is used for new connections. If this user -# has the "nopass" rule, then new connections will be immediately authenticated -# as the "default" user without the need of any password provided via the -# AUTH command. Otherwise if the "default" user is not flagged with "nopass" -# the connections will start in not authenticated state, and will require -# AUTH (or the HELLO command AUTH option) in order to be authenticated and -# start to work. -# -# The ACL rules that describe what a user can do are the following: -# -# on Enable the user: it is possible to authenticate as this user. -# off Disable the user: it's no longer possible to authenticate -# with this user, however the already authenticated connections -# will still work. -# skip-sanitize-payload RESTORE dump-payload sanitation is skipped. -# sanitize-payload RESTORE dump-payload is sanitized (default). -# + Allow the execution of that command -# - Disallow the execution of that command -# +@ Allow the execution of all the commands in such category -# with valid categories are like @admin, @set, @sortedset, ... -# and so forth, see the full list in the server.c file where -# the Redis command table is described and defined. -# The special category @all means all the commands, but currently -# present in the server, and that will be loaded in the future -# via modules. -# +|subcommand Allow a specific subcommand of an otherwise -# disabled command. Note that this form is not -# allowed as negative like -DEBUG|SEGFAULT, but -# only additive starting with "+". -# allcommands Alias for +@all. Note that it implies the ability to execute -# all the future commands loaded via the modules system. -# nocommands Alias for -@all. -# ~ Add a pattern of keys that can be mentioned as part of -# commands. For instance ~* allows all the keys. The pattern -# is a glob-style pattern like the one of KEYS. -# It is possible to specify multiple patterns. -# allkeys Alias for ~* -# resetkeys Flush the list of allowed keys patterns. -# & Add a glob-style pattern of Pub/Sub channels that can be -# accessed by the user. It is possible to specify multiple channel -# patterns. -# allchannels Alias for &* -# resetchannels Flush the list of allowed channel patterns. -# > Add this password to the list of valid password for the user. -# For example >mypass will add "mypass" to the list. -# This directive clears the "nopass" flag (see later). -# < Remove this password from the list of valid passwords. -# nopass All the set passwords of the user are removed, and the user -# is flagged as requiring no password: it means that every -# password will work against this user. If this directive is -# used for the default user, every new connection will be -# immediately authenticated with the default user without -# any explicit AUTH command required. Note that the "resetpass" -# directive will clear this condition. -# resetpass Flush the list of allowed passwords. Moreover removes the -# "nopass" status. After "resetpass" the user has no associated -# passwords and there is no way to authenticate without adding -# some password (or setting it as "nopass" later). -# reset Performs the following actions: resetpass, resetkeys, off, -# -@all. The user returns to the same state it has immediately -# after its creation. -# -# ACL rules can be specified in any order: for instance you can start with -# passwords, then flags, or key patterns. However note that the additive -# and subtractive rules will CHANGE MEANING depending on the ordering. -# For instance see the following example: -# -# user alice on +@all -DEBUG ~* >somepassword -# -# This will allow "alice" to use all the commands with the exception of the -# DEBUG command, since +@all added all the commands to the set of the commands -# alice can use, and later DEBUG was removed. However if we invert the order -# of two ACL rules the result will be different: -# -# user alice on -DEBUG +@all ~* >somepassword -# -# Now DEBUG was removed when alice had yet no commands in the set of allowed -# commands, later all the commands are added, so the user will be able to -# execute everything. -# -# Basically ACL rules are processed left-to-right. -# -# For more information about ACL configuration please refer to -# the Redis web site at https://redis.io/topics/acl - -# ACL LOG -# -# The ACL Log tracks failed commands and authentication events associated -# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked -# by ACLs. The ACL Log is stored in memory. You can reclaim memory with -# ACL LOG RESET. Define the maximum entry length of the ACL Log below. -acllog-max-len 128 - -# Using an external ACL file -# -# Instead of configuring users here in this file, it is possible to use -# a stand-alone file just listing users. The two methods cannot be mixed: -# if you configure users here and at the same time you activate the external -# ACL file, the server will refuse to start. -# -# The format of the external ACL user file is exactly the same as the -# format that is used inside redis.conf to describe users. -# -# aclfile /etc/redis/users.acl - -# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility -# layer on top of the new ACL system. The option effect will be just setting -# the password for the default user. Clients will still authenticate using -# AUTH as usually, or more explicitly with AUTH default -# if they follow the new protocol: both will work. -# -# The requirepass is not compatable with aclfile option and the ACL LOAD -# command, these will cause requirepass to be ignored. -# -# requirepass foobared - -# New users are initialized with restrictive permissions by default, via the -# equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it -# is possible to manage access to Pub/Sub channels with ACL rules as well. The -# default Pub/Sub channels permission if new users is controlled by the -# acl-pubsub-default configuration directive, which accepts one of these values: -# -# allchannels: grants access to all Pub/Sub channels -# resetchannels: revokes access to all Pub/Sub channels -# -# To ensure backward compatibility while upgrading Redis 6.0, acl-pubsub-default -# defaults to the 'allchannels' permission. -# -# Future compatibility note: it is very likely that in a future version of Redis -# the directive's default of 'allchannels' will be changed to 'resetchannels' in -# order to provide better out-of-the-box Pub/Sub security. Therefore, it is -# recommended that you explicitly define Pub/Sub permissions for all users -# rather then rely on implicit default values. Once you've set explicit -# Pub/Sub for all existing users, you should uncomment the following line. -# -# acl-pubsub-default resetchannels - -# Command renaming (DEPRECATED). -# -# ------------------------------------------------------------------------ -# WARNING: avoid using this option if possible. Instead use ACLs to remove -# commands from the default user, and put them only in some admin user you -# create for administrative purposes. -# ------------------------------------------------------------------------ -# -# It is possible to change the name of dangerous commands in a shared -# environment. For instance the CONFIG command may be renamed into something -# hard to guess so that it will still be available for internal-use tools -# but not available for general clients. -# -# Example: -# -# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 -# -# It is also possible to completely kill a command by renaming it into -# an empty string: -# -# rename-command CONFIG "" -# -# Please note that changing the name of commands that are logged into the -# AOF file or transmitted to replicas may cause problems. - -################################### CLIENTS #################################### - -# Set the max number of connected clients at the same time. By default -# this limit is set to 10000 clients, however if the Redis server is not -# able to configure the process file limit to allow for the specified limit -# the max number of allowed clients is set to the current file limit -# minus 32 (as Redis reserves a few file descriptors for internal uses). -# -# Once the limit is reached Redis will close all the new connections sending -# an error 'max number of clients reached'. -# -# IMPORTANT: When Redis Cluster is used, the max number of connections is also -# shared with the cluster bus: every node in the cluster will use two -# connections, one incoming and another outgoing. It is important to size the -# limit accordingly in case of very large clusters. -# -# maxclients 10000 - -############################## MEMORY MANAGEMENT ################################ - -# Set a memory usage limit to the specified amount of bytes. -# When the memory limit is reached Redis will try to remove keys -# according to the eviction policy selected (see maxmemory-policy). -# -# If Redis can't remove keys according to the policy, or if the policy is -# set to 'noeviction', Redis will start to reply with errors to commands -# that would use more memory, like SET, LPUSH, and so on, and will continue -# to reply to read-only commands like GET. -# -# This option is usually useful when using Redis as an LRU or LFU cache, or to -# set a hard memory limit for an instance (using the 'noeviction' policy). -# -# WARNING: If you have replicas attached to an instance with maxmemory on, -# the size of the output buffers needed to feed the replicas are subtracted -# from the used memory count, so that network problems / resyncs will -# not trigger a loop where keys are evicted, and in turn the output -# buffer of replicas is full with DELs of keys evicted triggering the deletion -# of more keys, and so forth until the database is completely emptied. -# -# In short... if you have replicas attached it is suggested that you set a lower -# limit for maxmemory so that there is some free RAM on the system for replica -# output buffers (but this is not needed if the policy is 'noeviction'). -# -# maxmemory - -# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory -# is reached. You can select one from the following behaviors: -# -# volatile-lru -> Evict using approximated LRU, only keys with an expire set. -# allkeys-lru -> Evict any key using approximated LRU. -# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. -# allkeys-lfu -> Evict any key using approximated LFU. -# volatile-random -> Remove a random key having an expire set. -# allkeys-random -> Remove a random key, any key. -# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) -# noeviction -> Don't evict anything, just return an error on write operations. -# -# LRU means Least Recently Used -# LFU means Least Frequently Used -# -# Both LRU, LFU and volatile-ttl are implemented using approximated -# randomized algorithms. -# -# Note: with any of the above policies, when there are no suitable keys for -# eviction, Redis will return an error on write operations that require -# more memory. These are usually commands that create new keys, add data or -# modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE, -# SORT (due to the STORE argument), and EXEC (if the transaction includes any -# command that requires memory). -# -# The default is: -# -# maxmemory-policy noeviction - -# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated -# algorithms (in order to save memory), so you can tune it for speed or -# accuracy. By default Redis will check five keys and pick the one that was -# used least recently, you can change the sample size using the following -# configuration directive. -# -# The default of 5 produces good enough results. 10 Approximates very closely -# true LRU but costs more CPU. 3 is faster but not very accurate. -# -# maxmemory-samples 5 - -# Eviction processing is designed to function well with the default setting. -# If there is an unusually large amount of write traffic, this value may need to -# be increased. Decreasing this value may reduce latency at the risk of -# eviction processing effectiveness -# 0 = minimum latency, 10 = default, 100 = process without regard to latency -# -# maxmemory-eviction-tenacity 10 - -# Starting from Redis 5, by default a replica will ignore its maxmemory setting -# (unless it is promoted to master after a failover or manually). It means -# that the eviction of keys will be just handled by the master, sending the -# DEL commands to the replica as keys evict in the master side. -# -# This behavior ensures that masters and replicas stay consistent, and is usually -# what you want, however if your replica is writable, or you want the replica -# to have a different memory setting, and you are sure all the writes performed -# to the replica are idempotent, then you may change this default (but be sure -# to understand what you are doing). -# -# Note that since the replica by default does not evict, it may end using more -# memory than the one set via maxmemory (there are certain buffers that may -# be larger on the replica, or data structures may sometimes take more memory -# and so forth). So make sure you monitor your replicas and make sure they -# have enough memory to never hit a real out-of-memory condition before the -# master hits the configured maxmemory setting. -# -# replica-ignore-maxmemory yes - -# Redis reclaims expired keys in two ways: upon access when those keys are -# found to be expired, and also in background, in what is called the -# "active expire key". The key space is slowly and interactively scanned -# looking for expired keys to reclaim, so that it is possible to free memory -# of keys that are expired and will never be accessed again in a short time. -# -# The default effort of the expire cycle will try to avoid having more than -# ten percent of expired keys still in memory, and will try to avoid consuming -# more than 25% of total memory and to add latency to the system. However -# it is possible to increase the expire "effort" that is normally set to -# "1", to a greater value, up to the value "10". At its maximum value the -# system will use more CPU, longer cycles (and technically may introduce -# more latency), and will tolerate less already expired keys still present -# in the system. It's a tradeoff between memory, CPU and latency. -# -# active-expire-effort 1 - -############################# LAZY FREEING #################################### - -# Redis has two primitives to delete keys. One is called DEL and is a blocking -# deletion of the object. It means that the server stops processing new commands -# in order to reclaim all the memory associated with an object in a synchronous -# way. If the key deleted is associated with a small object, the time needed -# in order to execute the DEL command is very small and comparable to most other -# O(1) or O(log_N) commands in Redis. However if the key is associated with an -# aggregated value containing millions of elements, the server can block for -# a long time (even seconds) in order to complete the operation. -# -# For the above reasons Redis also offers non blocking deletion primitives -# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and -# FLUSHDB commands, in order to reclaim memory in background. Those commands -# are executed in constant time. Another thread will incrementally free the -# object in the background as fast as possible. -# -# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. -# It's up to the design of the application to understand when it is a good -# idea to use one or the other. However the Redis server sometimes has to -# delete keys or flush the whole database as a side effect of other operations. -# Specifically Redis deletes objects independently of a user call in the -# following scenarios: -# -# 1) On eviction, because of the maxmemory and maxmemory policy configurations, -# in order to make room for new data, without going over the specified -# memory limit. -# 2) Because of expire: when a key with an associated time to live (see the -# EXPIRE command) must be deleted from memory. -# 3) Because of a side effect of a command that stores data on a key that may -# already exist. For example the RENAME command may delete the old key -# content when it is replaced with another one. Similarly SUNIONSTORE -# or SORT with STORE option may delete existing keys. The SET command -# itself removes any old content of the specified key in order to replace -# it with the specified string. -# 4) During replication, when a replica performs a full resynchronization with -# its master, the content of the whole database is removed in order to -# load the RDB file just transferred. -# -# In all the above cases the default is to delete objects in a blocking way, -# like if DEL was called. However you can configure each case specifically -# in order to instead release memory in a non-blocking way like if UNLINK -# was called, using the following configuration directives. - -lazyfree-lazy-eviction no -lazyfree-lazy-expire no -lazyfree-lazy-server-del no -replica-lazy-flush no - -# It is also possible, for the case when to replace the user code DEL calls -# with UNLINK calls is not easy, to modify the default behavior of the DEL -# command to act exactly like UNLINK, using the following configuration -# directive: - -lazyfree-lazy-user-del no - -# FLUSHDB, FLUSHALL, and SCRIPT FLUSH support both asynchronous and synchronous -# deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the -# commands. When neither flag is passed, this directive will be used to determine -# if the data should be deleted asynchronously. - -lazyfree-lazy-user-flush no - -################################ THREADED I/O ################################# - -# Redis is mostly single threaded, however there are certain threaded -# operations such as UNLINK, slow I/O accesses and other things that are -# performed on side threads. -# -# Now it is also possible to handle Redis clients socket reads and writes -# in different I/O threads. Since especially writing is so slow, normally -# Redis users use pipelining in order to speed up the Redis performances per -# core, and spawn multiple instances in order to scale more. Using I/O -# threads it is possible to easily speedup two times Redis without resorting -# to pipelining nor sharding of the instance. -# -# By default threading is disabled, we suggest enabling it only in machines -# that have at least 4 or more cores, leaving at least one spare core. -# Using more than 8 threads is unlikely to help much. We also recommend using -# threaded I/O only if you actually have performance problems, with Redis -# instances being able to use a quite big percentage of CPU time, otherwise -# there is no point in using this feature. -# -# So for instance if you have a four cores boxes, try to use 2 or 3 I/O -# threads, if you have a 8 cores, try to use 6 threads. In order to -# enable I/O threads use the following configuration directive: -# -# io-threads 4 -# -# Setting io-threads to 1 will just use the main thread as usual. -# When I/O threads are enabled, we only use threads for writes, that is -# to thread the write(2) syscall and transfer the client buffers to the -# socket. However it is also possible to enable threading of reads and -# protocol parsing using the following configuration directive, by setting -# it to yes: -# -# io-threads-do-reads no -# -# Usually threading reads doesn't help much. -# -# NOTE 1: This configuration directive cannot be changed at runtime via -# CONFIG SET. Aso this feature currently does not work when SSL is -# enabled. -# -# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make -# sure you also run the benchmark itself in threaded mode, using the -# --threads option to match the number of Redis threads, otherwise you'll not -# be able to notice the improvements. - -############################ KERNEL OOM CONTROL ############################## - -# On Linux, it is possible to hint the kernel OOM killer on what processes -# should be killed first when out of memory. -# -# Enabling this feature makes Redis actively control the oom_score_adj value -# for all its processes, depending on their role. The default scores will -# attempt to have background child processes killed before all others, and -# replicas killed before masters. -# -# Redis supports three options: -# -# no: Don't make changes to oom-score-adj (default). -# yes: Alias to "relative" see below. -# absolute: Values in oom-score-adj-values are written as is to the kernel. -# relative: Values are used relative to the initial value of oom_score_adj when -# the server starts and are then clamped to a range of -1000 to 1000. -# Because typically the initial value is 0, they will often match the -# absolute values. -oom-score-adj no - -# When oom-score-adj is used, this directive controls the specific values used -# for master, replica and background child processes. Values range -2000 to -# 2000 (higher means more likely to be killed). -# -# Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities) -# can freely increase their value, but not decrease it below its initial -# settings. This means that setting oom-score-adj to "relative" and setting the -# oom-score-adj-values to positive values will always succeed. -oom-score-adj-values 0 200 800 - - -#################### KERNEL transparent hugepage CONTROL ###################### - -# Usually the kernel Transparent Huge Pages control is set to "madvise" or -# or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which -# case this config has no effect. On systems in which it is set to "always", -# redis will attempt to disable it specifically for the redis process in order -# to avoid latency problems specifically with fork(2) and CoW. -# If for some reason you prefer to keep it enabled, you can set this config to -# "no" and the kernel global to "always". - -disable-thp yes - -############################## APPEND ONLY MODE ############################### - -# By default Redis asynchronously dumps the dataset on disk. This mode is -# good enough in many applications, but an issue with the Redis process or -# a power outage may result into a few minutes of writes lost (depending on -# the configured save points). -# -# The Append Only File is an alternative persistence mode that provides -# much better durability. For instance using the default data fsync policy -# (see later in the config file) Redis can lose just one second of writes in a -# dramatic event like a server power outage, or a single write if something -# wrong with the Redis process itself happens, but the operating system is -# still running correctly. -# -# AOF and RDB persistence can be enabled at the same time without problems. -# If the AOF is enabled on startup Redis will load the AOF, that is the file -# with the better durability guarantees. -# -# Please check https://redis.io/topics/persistence for more information. - -appendonly no - -# The name of the append only file (default: "appendonly.aof") - -appendfilename "appendonly.aof" - -# The fsync() call tells the Operating System to actually write data on disk -# instead of waiting for more data in the output buffer. Some OS will really flush -# data on disk, some other OS will just try to do it ASAP. -# -# Redis supports three different modes: -# -# no: don't fsync, just let the OS flush the data when it wants. Faster. -# always: fsync after every write to the append only log. Slow, Safest. -# everysec: fsync only one time every second. Compromise. -# -# The default is "everysec", as that's usually the right compromise between -# speed and data safety. It's up to you to understand if you can relax this to -# "no" that will let the operating system flush the output buffer when -# it wants, for better performances (but if you can live with the idea of -# some data loss consider the default persistence mode that's snapshotting), -# or on the contrary, use "always" that's very slow but a bit safer than -# everysec. -# -# More details please check the following article: -# http://antirez.com/post/redis-persistence-demystified.html -# -# If unsure, use "everysec". - -# appendfsync always -appendfsync everysec -# appendfsync no - -# When the AOF fsync policy is set to always or everysec, and a background -# saving process (a background save or AOF log background rewriting) is -# performing a lot of I/O against the disk, in some Linux configurations -# Redis may block too long on the fsync() call. Note that there is no fix for -# this currently, as even performing fsync in a different thread will block -# our synchronous write(2) call. -# -# In order to mitigate this problem it's possible to use the following option -# that will prevent fsync() from being called in the main process while a -# BGSAVE or BGREWRITEAOF is in progress. -# -# This means that while another child is saving, the durability of Redis is -# the same as "appendfsync none". In practical terms, this means that it is -# possible to lose up to 30 seconds of log in the worst scenario (with the -# default Linux settings). -# -# If you have latency problems turn this to "yes". Otherwise leave it as -# "no" that is the safest pick from the point of view of durability. - -no-appendfsync-on-rewrite no - -# Automatic rewrite of the append only file. -# Redis is able to automatically rewrite the log file implicitly calling -# BGREWRITEAOF when the AOF log size grows by the specified percentage. -# -# This is how it works: Redis remembers the size of the AOF file after the -# latest rewrite (if no rewrite has happened since the restart, the size of -# the AOF at startup is used). -# -# This base size is compared to the current size. If the current size is -# bigger than the specified percentage, the rewrite is triggered. Also -# you need to specify a minimal size for the AOF file to be rewritten, this -# is useful to avoid rewriting the AOF file even if the percentage increase -# is reached but it is still pretty small. -# -# Specify a percentage of zero in order to disable the automatic AOF -# rewrite feature. - -auto-aof-rewrite-percentage 100 -auto-aof-rewrite-min-size 64mb - -# An AOF file may be found to be truncated at the end during the Redis -# startup process, when the AOF data gets loaded back into memory. -# This may happen when the system where Redis is running -# crashes, especially when an ext4 filesystem is mounted without the -# data=ordered option (however this can't happen when Redis itself -# crashes or aborts but the operating system still works correctly). -# -# Redis can either exit with an error when this happens, or load as much -# data as possible (the default now) and start if the AOF file is found -# to be truncated at the end. The following option controls this behavior. -# -# If aof-load-truncated is set to yes, a truncated AOF file is loaded and -# the Redis server starts emitting a log to inform the user of the event. -# Otherwise if the option is set to no, the server aborts with an error -# and refuses to start. When the option is set to no, the user requires -# to fix the AOF file using the "redis-check-aof" utility before to restart -# the server. -# -# Note that if the AOF file will be found to be corrupted in the middle -# the server will still exit with an error. This option only applies when -# Redis will try to read more data from the AOF file but not enough bytes -# will be found. -aof-load-truncated yes - -# When rewriting the AOF file, Redis is able to use an RDB preamble in the -# AOF file for faster rewrites and recoveries. When this option is turned -# on the rewritten AOF file is composed of two different stanzas: -# -# [RDB file][AOF tail] -# -# When loading, Redis recognizes that the AOF file starts with the "REDIS" -# string and loads the prefixed RDB file, then continues loading the AOF -# tail. -aof-use-rdb-preamble yes - -################################ LUA SCRIPTING ############################### - -# Max execution time of a Lua script in milliseconds. -# -# If the maximum execution time is reached Redis will log that a script is -# still in execution after the maximum allowed time and will start to -# reply to queries with an error. -# -# When a long running script exceeds the maximum execution time only the -# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be -# used to stop a script that did not yet call any write commands. The second -# is the only way to shut down the server in the case a write command was -# already issued by the script but the user doesn't want to wait for the natural -# termination of the script. -# -# Set it to 0 or a negative value for unlimited execution without warnings. -lua-time-limit 5000 - -################################ REDIS CLUSTER ############################### - -# Normal Redis instances can't be part of a Redis Cluster; only nodes that are -# started as cluster nodes can. In order to start a Redis instance as a -# cluster node enable the cluster support uncommenting the following: -# -# cluster-enabled yes - -# Every cluster node has a cluster configuration file. This file is not -# intended to be edited by hand. It is created and updated by Redis nodes. -# Every Redis Cluster node requires a different cluster configuration file. -# Make sure that instances running in the same system do not have -# overlapping cluster configuration file names. -# -# cluster-config-file nodes-6379.conf - -# Cluster node timeout is the amount of milliseconds a node must be unreachable -# for it to be considered in failure state. -# Most other internal time limits are a multiple of the node timeout. -# -# cluster-node-timeout 15000 - -# A replica of a failing master will avoid to start a failover if its data -# looks too old. -# -# There is no simple way for a replica to actually have an exact measure of -# its "data age", so the following two checks are performed: -# -# 1) If there are multiple replicas able to failover, they exchange messages -# in order to try to give an advantage to the replica with the best -# replication offset (more data from the master processed). -# Replicas will try to get their rank by offset, and apply to the start -# of the failover a delay proportional to their rank. -# -# 2) Every single replica computes the time of the last interaction with -# its master. This can be the last ping or command received (if the master -# is still in the "connected" state), or the time that elapsed since the -# disconnection with the master (if the replication link is currently down). -# If the last interaction is too old, the replica will not try to failover -# at all. -# -# The point "2" can be tuned by user. Specifically a replica will not perform -# the failover if, since the last interaction with the master, the time -# elapsed is greater than: -# -# (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period -# -# So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor -# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the -# replica will not try to failover if it was not able to talk with the master -# for longer than 310 seconds. -# -# A large cluster-replica-validity-factor may allow replicas with too old data to failover -# a master, while a too small value may prevent the cluster from being able to -# elect a replica at all. -# -# For maximum availability, it is possible to set the cluster-replica-validity-factor -# to a value of 0, which means, that replicas will always try to failover the -# master regardless of the last time they interacted with the master. -# (However they'll always try to apply a delay proportional to their -# offset rank). -# -# Zero is the only value able to guarantee that when all the partitions heal -# the cluster will always be able to continue. -# -# cluster-replica-validity-factor 10 - -# Cluster replicas are able to migrate to orphaned masters, that are masters -# that are left without working replicas. This improves the cluster ability -# to resist to failures as otherwise an orphaned master can't be failed over -# in case of failure if it has no working replicas. -# -# Replicas migrate to orphaned masters only if there are still at least a -# given number of other working replicas for their old master. This number -# is the "migration barrier". A migration barrier of 1 means that a replica -# will migrate only if there is at least 1 other working replica for its master -# and so forth. It usually reflects the number of replicas you want for every -# master in your cluster. -# -# Default is 1 (replicas migrate only if their masters remain with at least -# one replica). To disable migration just set it to a very large value or -# set cluster-allow-replica-migration to 'no'. -# A value of 0 can be set but is useful only for debugging and dangerous -# in production. -# -# cluster-migration-barrier 1 - -# Turning off this option allows to use less automatic cluster configuration. -# It both disables migration to orphaned masters and migration from masters -# that became empty. -# -# Default is 'yes' (allow automatic migrations). -# -# cluster-allow-replica-migration yes - -# By default Redis Cluster nodes stop accepting queries if they detect there -# is at least a hash slot uncovered (no available node is serving it). -# This way if the cluster is partially down (for example a range of hash slots -# are no longer covered) all the cluster becomes, eventually, unavailable. -# It automatically returns available as soon as all the slots are covered again. -# -# However sometimes you want the subset of the cluster which is working, -# to continue to accept queries for the part of the key space that is still -# covered. In order to do so, just set the cluster-require-full-coverage -# option to no. -# -# cluster-require-full-coverage yes - -# This option, when set to yes, prevents replicas from trying to failover its -# master during master failures. However the replica can still perform a -# manual failover, if forced to do so. -# -# This is useful in different scenarios, especially in the case of multiple -# data center operations, where we want one side to never be promoted if not -# in the case of a total DC failure. -# -# cluster-replica-no-failover no - -# This option, when set to yes, allows nodes to serve read traffic while the -# the cluster is in a down state, as long as it believes it owns the slots. -# -# This is useful for two cases. The first case is for when an application -# doesn't require consistency of data during node failures or network partitions. -# One example of this is a cache, where as long as the node has the data it -# should be able to serve it. -# -# The second use case is for configurations that don't meet the recommended -# three shards but want to enable cluster mode and scale later. A -# master outage in a 1 or 2 shard configuration causes a read/write outage to the -# entire cluster without this option set, with it set there is only a write outage. -# Without a quorum of masters, slot ownership will not change automatically. -# -# cluster-allow-reads-when-down no - -# In order to setup your cluster make sure to read the documentation -# available at https://redis.io web site. - -########################## CLUSTER DOCKER/NAT support ######################## - -# In certain deployments, Redis Cluster nodes address discovery fails, because -# addresses are NAT-ted or because ports are forwarded (the typical case is -# Docker and other containers). -# -# In order to make Redis Cluster working in such environments, a static -# configuration where each node knows its public address is needed. The -# following four options are used for this scope, and are: -# -# * cluster-announce-ip -# * cluster-announce-port -# * cluster-announce-tls-port -# * cluster-announce-bus-port -# -# Each instructs the node about its address, client ports (for connections -# without and with TLS) and cluster message bus port. The information is then -# published in the header of the bus packets so that other nodes will be able to -# correctly map the address of the node publishing the information. -# -# If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set -# to zero, then cluster-announce-port refers to the TLS port. Note also that -# cluster-announce-tls-port has no effect if cluster-tls is set to no. -# -# If the above options are not used, the normal Redis Cluster auto-detection -# will be used instead. -# -# Note that when remapped, the bus port may not be at the fixed offset of -# clients port + 10000, so you can specify any port and bus-port depending -# on how they get remapped. If the bus-port is not set, a fixed offset of -# 10000 will be used as usual. -# -# Example: -# -# cluster-announce-ip 10.1.1.5 -# cluster-announce-tls-port 6379 -# cluster-announce-port 0 -# cluster-announce-bus-port 6380 - -################################## SLOW LOG ################################### - -# The Redis Slow Log is a system to log queries that exceeded a specified -# execution time. The execution time does not include the I/O operations -# like talking with the client, sending the reply and so forth, -# but just the time needed to actually execute the command (this is the only -# stage of command execution where the thread is blocked and can not serve -# other requests in the meantime). -# -# You can configure the slow log with two parameters: one tells Redis -# what is the execution time, in microseconds, to exceed in order for the -# command to get logged, and the other parameter is the length of the -# slow log. When a new command is logged the oldest one is removed from the -# queue of logged commands. - -# The following time is expressed in microseconds, so 1000000 is equivalent -# to one second. Note that a negative number disables the slow log, while -# a value of zero forces the logging of every command. -slowlog-log-slower-than 10000 - -# There is no limit to this length. Just be aware that it will consume memory. -# You can reclaim memory used by the slow log with SLOWLOG RESET. -slowlog-max-len 128 - -################################ LATENCY MONITOR ############################## - -# The Redis latency monitoring subsystem samples different operations -# at runtime in order to collect data related to possible sources of -# latency of a Redis instance. -# -# Via the LATENCY command this information is available to the user that can -# print graphs and obtain reports. -# -# The system only logs operations that were performed in a time equal or -# greater than the amount of milliseconds specified via the -# latency-monitor-threshold configuration directive. When its value is set -# to zero, the latency monitor is turned off. -# -# By default latency monitoring is disabled since it is mostly not needed -# if you don't have latency issues, and collecting data has a performance -# impact, that while very small, can be measured under big load. Latency -# monitoring can easily be enabled at runtime using the command -# "CONFIG SET latency-monitor-threshold " if needed. -latency-monitor-threshold 0 - -############################# EVENT NOTIFICATION ############################## - -# Redis can notify Pub/Sub clients about events happening in the key space. -# This feature is documented at https://redis.io/topics/notifications -# -# For instance if keyspace events notification is enabled, and a client -# performs a DEL operation on key "foo" stored in the Database 0, two -# messages will be published via Pub/Sub: -# -# PUBLISH __keyspace@0__:foo del -# PUBLISH __keyevent@0__:del foo -# -# It is possible to select the events that Redis will notify among a set -# of classes. Every class is identified by a single character: -# -# K Keyspace events, published with __keyspace@__ prefix. -# E Keyevent events, published with __keyevent@__ prefix. -# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... -# $ String commands -# l List commands -# s Set commands -# h Hash commands -# z Sorted set commands -# x Expired events (events generated every time a key expires) -# e Evicted events (events generated when a key is evicted for maxmemory) -# t Stream commands -# d Module key type events -# m Key-miss events (Note: It is not included in the 'A' class) -# A Alias for g$lshzxetd, so that the "AKE" string means all the events -# (Except key-miss events which are excluded from 'A' due to their -# unique nature). -# -# The "notify-keyspace-events" takes as argument a string that is composed -# of zero or multiple characters. The empty string means that notifications -# are disabled. -# -# Example: to enable list and generic events, from the point of view of the -# event name, use: -# -# notify-keyspace-events Elg -# -# Example 2: to get the stream of the expired keys subscribing to channel -# name __keyevent@0__:expired use: -# -# notify-keyspace-events Ex -# -# By default all notifications are disabled because most users don't need -# this feature and the feature has some overhead. Note that if you don't -# specify at least one of K or E, no events will be delivered. -notify-keyspace-events "" - -############################### GOPHER SERVER ################################# - -# Redis contains an implementation of the Gopher protocol, as specified in -# the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt). -# -# The Gopher protocol was very popular in the late '90s. It is an alternative -# to the web, and the implementation both server and client side is so simple -# that the Redis server has just 100 lines of code in order to implement this -# support. -# -# What do you do with Gopher nowadays? Well Gopher never *really* died, and -# lately there is a movement in order for the Gopher more hierarchical content -# composed of just plain text documents to be resurrected. Some want a simpler -# internet, others believe that the mainstream internet became too much -# controlled, and it's cool to create an alternative space for people that -# want a bit of fresh air. -# -# Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol -# as a gift. -# -# --- HOW IT WORKS? --- -# -# The Redis Gopher support uses the inline protocol of Redis, and specifically -# two kind of inline requests that were anyway illegal: an empty request -# or any request that starts with "/" (there are no Redis commands starting -# with such a slash). Normal RESP2/RESP3 requests are completely out of the -# path of the Gopher protocol implementation and are served as usual as well. -# -# If you open a connection to Redis when Gopher is enabled and send it -# a string like "/foo", if there is a key named "/foo" it is served via the -# Gopher protocol. -# -# In order to create a real Gopher "hole" (the name of a Gopher site in Gopher -# talking), you likely need a script like the following: -# -# https://github.com/antirez/gopher2redis -# -# --- SECURITY WARNING --- -# -# If you plan to put Redis on the internet in a publicly accessible address -# to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance. -# Once a password is set: -# -# 1. The Gopher server (when enabled, not by default) will still serve -# content via Gopher. -# 2. However other commands cannot be called before the client will -# authenticate. -# -# So use the 'requirepass' option to protect your instance. -# -# Note that Gopher is not currently supported when 'io-threads-do-reads' -# is enabled. -# -# To enable Gopher support, uncomment the following line and set the option -# from no (the default) to yes. -# -# gopher-enabled no - -############################### ADVANCED CONFIG ############################### - -# Hashes are encoded using a memory efficient data structure when they have a -# small number of entries, and the biggest entry does not exceed a given -# threshold. These thresholds can be configured using the following directives. -hash-max-ziplist-entries 512 -hash-max-ziplist-value 64 - -# Lists are also encoded in a special way to save a lot of space. -# The number of entries allowed per internal list node can be specified -# as a fixed maximum size or a maximum number of elements. -# For a fixed maximum size, use -5 through -1, meaning: -# -5: max size: 64 Kb <-- not recommended for normal workloads -# -4: max size: 32 Kb <-- not recommended -# -3: max size: 16 Kb <-- probably not recommended -# -2: max size: 8 Kb <-- good -# -1: max size: 4 Kb <-- good -# Positive numbers mean store up to _exactly_ that number of elements -# per list node. -# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), -# but if your use case is unique, adjust the settings as necessary. -list-max-ziplist-size -2 - -# Lists may also be compressed. -# Compress depth is the number of quicklist ziplist nodes from *each* side of -# the list to *exclude* from compression. The head and tail of the list -# are always uncompressed for fast push/pop operations. Settings are: -# 0: disable all list compression -# 1: depth 1 means "don't start compressing until after 1 node into the list, -# going from either the head or tail" -# So: [head]->node->node->...->node->[tail] -# [head], [tail] will always be uncompressed; inner nodes will compress. -# 2: [head]->[next]->node->node->...->node->[prev]->[tail] -# 2 here means: don't compress head or head->next or tail->prev or tail, -# but compress all nodes between them. -# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] -# etc. -list-compress-depth 0 - -# Sets have a special encoding in just one case: when a set is composed -# of just strings that happen to be integers in radix 10 in the range -# of 64 bit signed integers. -# The following configuration setting sets the limit in the size of the -# set in order to use this special memory saving encoding. -set-max-intset-entries 512 - -# Similarly to hashes and lists, sorted sets are also specially encoded in -# order to save a lot of space. This encoding is only used when the length and -# elements of a sorted set are below the following limits: -zset-max-ziplist-entries 128 -zset-max-ziplist-value 64 - -# HyperLogLog sparse representation bytes limit. The limit includes the -# 16 bytes header. When an HyperLogLog using the sparse representation crosses -# this limit, it is converted into the dense representation. -# -# A value greater than 16000 is totally useless, since at that point the -# dense representation is more memory efficient. -# -# The suggested value is ~ 3000 in order to have the benefits of -# the space efficient encoding without slowing down too much PFADD, -# which is O(N) with the sparse encoding. The value can be raised to -# ~ 10000 when CPU is not a concern, but space is, and the data set is -# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. -hll-sparse-max-bytes 3000 - -# Streams macro node max size / items. The stream data structure is a radix -# tree of big nodes that encode multiple items inside. Using this configuration -# it is possible to configure how big a single node can be in bytes, and the -# maximum number of items it may contain before switching to a new node when -# appending new stream entries. If any of the following settings are set to -# zero, the limit is ignored, so for instance it is possible to set just a -# max entries limit by setting max-bytes to 0 and max-entries to the desired -# value. -stream-node-max-bytes 4096 -stream-node-max-entries 100 - -# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in -# order to help rehashing the main Redis hash table (the one mapping top-level -# keys to values). The hash table implementation Redis uses (see dict.c) -# performs a lazy rehashing: the more operation you run into a hash table -# that is rehashing, the more rehashing "steps" are performed, so if the -# server is idle the rehashing is never complete and some more memory is used -# by the hash table. -# -# The default is to use this millisecond 10 times every second in order to -# actively rehash the main dictionaries, freeing memory when possible. -# -# If unsure: -# use "activerehashing no" if you have hard latency requirements and it is -# not a good thing in your environment that Redis can reply from time to time -# to queries with 2 milliseconds delay. -# -# use "activerehashing yes" if you don't have such hard requirements but -# want to free memory asap when possible. -activerehashing yes - -# The client output buffer limits can be used to force disconnection of clients -# that are not reading data from the server fast enough for some reason (a -# common reason is that a Pub/Sub client can't consume messages as fast as the -# publisher can produce them). -# -# The limit can be set differently for the three different classes of clients: -# -# normal -> normal clients including MONITOR clients -# replica -> replica clients -# pubsub -> clients subscribed to at least one pubsub channel or pattern -# -# The syntax of every client-output-buffer-limit directive is the following: -# -# client-output-buffer-limit -# -# A client is immediately disconnected once the hard limit is reached, or if -# the soft limit is reached and remains reached for the specified number of -# seconds (continuously). -# So for instance if the hard limit is 32 megabytes and the soft limit is -# 16 megabytes / 10 seconds, the client will get disconnected immediately -# if the size of the output buffers reach 32 megabytes, but will also get -# disconnected if the client reaches 16 megabytes and continuously overcomes -# the limit for 10 seconds. -# -# By default normal clients are not limited because they don't receive data -# without asking (in a push way), but just after a request, so only -# asynchronous clients may create a scenario where data is requested faster -# than it can read. -# -# Instead there is a default limit for pubsub and replica clients, since -# subscribers and replicas receive data in a push fashion. -# -# Both the hard or the soft limit can be disabled by setting them to zero. -client-output-buffer-limit normal 0 0 0 -client-output-buffer-limit replica 256mb 64mb 60 -client-output-buffer-limit pubsub 32mb 8mb 60 - -# Client query buffers accumulate new commands. They are limited to a fixed -# amount by default in order to avoid that a protocol desynchronization (for -# instance due to a bug in the client) will lead to unbound memory usage in -# the query buffer. However you can configure it here if you have very special -# needs, such us huge multi/exec requests or alike. -# -# client-query-buffer-limit 1gb - -# In the Redis protocol, bulk requests, that are, elements representing single -# strings, are normally limited to 512 mb. However you can change this limit -# here, but must be 1mb or greater -# -# proto-max-bulk-len 512mb - -# Redis calls an internal function to perform many background tasks, like -# closing connections of clients in timeout, purging expired keys that are -# never requested, and so forth. -# -# Not all tasks are performed with the same frequency, but Redis checks for -# tasks to perform according to the specified "hz" value. -# -# By default "hz" is set to 10. Raising the value will use more CPU when -# Redis is idle, but at the same time will make Redis more responsive when -# there are many keys expiring at the same time, and timeouts may be -# handled with more precision. -# -# The range is between 1 and 500, however a value over 100 is usually not -# a good idea. Most users should use the default of 10 and raise this up to -# 100 only in environments where very low latency is required. -hz 10 - -# Normally it is useful to have an HZ value which is proportional to the -# number of clients connected. This is useful in order, for instance, to -# avoid too many clients are processed for each background task invocation -# in order to avoid latency spikes. -# -# Since the default HZ value by default is conservatively set to 10, Redis -# offers, and enables by default, the ability to use an adaptive HZ value -# which will temporarily raise when there are many connected clients. -# -# When dynamic HZ is enabled, the actual configured HZ will be used -# as a baseline, but multiples of the configured HZ value will be actually -# used as needed once more clients are connected. In this way an idle -# instance will use very little CPU time while a busy instance will be -# more responsive. -dynamic-hz yes - -# When a child rewrites the AOF file, if the following option is enabled -# the file will be fsync-ed every 32 MB of data generated. This is useful -# in order to commit the file to the disk more incrementally and avoid -# big latency spikes. -aof-rewrite-incremental-fsync yes - -# When redis saves RDB file, if the following option is enabled -# the file will be fsync-ed every 32 MB of data generated. This is useful -# in order to commit the file to the disk more incrementally and avoid -# big latency spikes. -rdb-save-incremental-fsync yes - -# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good -# idea to start with the default settings and only change them after investigating -# how to improve the performances and how the keys LFU change over time, which -# is possible to inspect via the OBJECT FREQ command. -# -# There are two tunable parameters in the Redis LFU implementation: the -# counter logarithm factor and the counter decay time. It is important to -# understand what the two parameters mean before changing them. -# -# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis -# uses a probabilistic increment with logarithmic behavior. Given the value -# of the old counter, when a key is accessed, the counter is incremented in -# this way: -# -# 1. A random number R between 0 and 1 is extracted. -# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). -# 3. The counter is incremented only if R < P. -# -# The default lfu-log-factor is 10. This is a table of how the frequency -# counter changes with a different number of accesses with different -# logarithmic factors: -# -# +--------+------------+------------+------------+------------+------------+ -# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | -# +--------+------------+------------+------------+------------+------------+ -# | 0 | 104 | 255 | 255 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 1 | 18 | 49 | 255 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 10 | 10 | 18 | 142 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 100 | 8 | 11 | 49 | 143 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# -# NOTE: The above table was obtained by running the following commands: -# -# redis-benchmark -n 1000000 incr foo -# redis-cli object freq foo -# -# NOTE 2: The counter initial value is 5 in order to give new objects a chance -# to accumulate hits. -# -# The counter decay time is the time, in minutes, that must elapse in order -# for the key counter to be divided by two (or decremented if it has a value -# less <= 10). -# -# The default value for the lfu-decay-time is 1. A special value of 0 means to -# decay the counter every time it happens to be scanned. -# -# lfu-log-factor 10 -# lfu-decay-time 1 - -########################### ACTIVE DEFRAGMENTATION ####################### -# -# What is active defragmentation? -# ------------------------------- -# -# Active (online) defragmentation allows a Redis server to compact the -# spaces left between small allocations and deallocations of data in memory, -# thus allowing to reclaim back memory. -# -# Fragmentation is a natural process that happens with every allocator (but -# less so with Jemalloc, fortunately) and certain workloads. Normally a server -# restart is needed in order to lower the fragmentation, or at least to flush -# away all the data and create it again. However thanks to this feature -# implemented by Oran Agra for Redis 4.0 this process can happen at runtime -# in a "hot" way, while the server is running. -# -# Basically when the fragmentation is over a certain level (see the -# configuration options below) Redis will start to create new copies of the -# values in contiguous memory regions by exploiting certain specific Jemalloc -# features (in order to understand if an allocation is causing fragmentation -# and to allocate it in a better place), and at the same time, will release the -# old copies of the data. This process, repeated incrementally for all the keys -# will cause the fragmentation to drop back to normal values. -# -# Important things to understand: -# -# 1. This feature is disabled by default, and only works if you compiled Redis -# to use the copy of Jemalloc we ship with the source code of Redis. -# This is the default with Linux builds. -# -# 2. You never need to enable this feature if you don't have fragmentation -# issues. -# -# 3. Once you experience fragmentation, you can enable this feature when -# needed with the command "CONFIG SET activedefrag yes". -# -# The configuration parameters are able to fine tune the behavior of the -# defragmentation process. If you are not sure about what they mean it is -# a good idea to leave the defaults untouched. - -# Enabled active defragmentation -# activedefrag no - -# Minimum amount of fragmentation waste to start active defrag -# active-defrag-ignore-bytes 100mb - -# Minimum percentage of fragmentation to start active defrag -# active-defrag-threshold-lower 10 - -# Maximum percentage of fragmentation at which we use maximum effort -# active-defrag-threshold-upper 100 - -# Minimal effort for defrag in CPU percentage, to be used when the lower -# threshold is reached -# active-defrag-cycle-min 1 - -# Maximal effort for defrag in CPU percentage, to be used when the upper -# threshold is reached -# active-defrag-cycle-max 25 - -# Maximum number of set/hash/zset/list fields that will be processed from -# the main dictionary scan -# active-defrag-max-scan-fields 1000 - -# Jemalloc background thread for purging will be enabled by default -jemalloc-bg-thread yes - -# It is possible to pin different threads and processes of Redis to specific -# CPUs in your system, in order to maximize the performances of the server. -# This is useful both in order to pin different Redis threads in different -# CPUs, but also in order to make sure that multiple Redis instances running -# in the same host will be pinned to different CPUs. -# -# Normally you can do this using the "taskset" command, however it is also -# possible to this via Redis configuration directly, both in Linux and FreeBSD. -# -# You can pin the server/IO threads, bio threads, aof rewrite child process, and -# the bgsave child process. The syntax to specify the cpu list is the same as -# the taskset command: -# -# Set redis server/io threads to cpu affinity 0,2,4,6: -# server_cpulist 0-7:2 -# -# Set bio threads to cpu affinity 1,3: -# bio_cpulist 1,3 -# -# Set aof rewrite child process to cpu affinity 8,9,10,11: -# aof_rewrite_cpulist 8-11 -# -# Set bgsave child process to cpu affinity 1,10,11 -# bgsave_cpulist 1,10-11 - -# In some cases redis will emit warnings and even refuse to start if it detects -# that the system is in bad state, it is possible to suppress these warnings -# by setting the following config which takes a space delimited list of warnings -# to suppress -# -# ignore-warnings ARM64-COW-BUG From 21ab6572cc552ede81e5e487f3962a69680966af Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:13:17 +0530 Subject: [PATCH 10/15] removed remaining ansiblew config --- packages/grid/ansible.cfg | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 packages/grid/ansible.cfg diff --git a/packages/grid/ansible.cfg b/packages/grid/ansible.cfg deleted file mode 100644 index 007cefdba32..00000000000 --- a/packages/grid/ansible.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[defaults] -# allow_world_readable_tmpfiles=true -pipelining = True -host_key_checking = false -interpreter_python = auto From ca271e0201029093bd5492ad994734cf51720eb8 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:16:59 +0530 Subject: [PATCH 11/15] remove docker compose and old grid readme --- packages/grid/README.md | 791 ------------------------- packages/grid/docker-compose.build.yml | 24 - packages/grid/docker-compose.dev.yml | 77 --- packages/grid/docker-compose.pull.yml | 26 - packages/grid/docker-compose.test.yml | 37 -- packages/grid/docker-compose.tls.yml | 14 - packages/grid/docker-compose.yml | 314 ---------- 7 files changed, 1283 deletions(-) delete mode 100644 packages/grid/README.md delete mode 100644 packages/grid/docker-compose.build.yml delete mode 100644 packages/grid/docker-compose.dev.yml delete mode 100644 packages/grid/docker-compose.pull.yml delete mode 100644 packages/grid/docker-compose.test.yml delete mode 100644 packages/grid/docker-compose.tls.yml delete mode 100644 packages/grid/docker-compose.yml diff --git a/packages/grid/README.md b/packages/grid/README.md deleted file mode 100644 index c9dd9508514..00000000000 --- a/packages/grid/README.md +++ /dev/null @@ -1,791 +0,0 @@ -# grid - -## Backend Requirements - -- [Docker](https://www.docker.com/). -- [Docker Compose](https://docs.docker.com/compose/install/). -- [Poetry](https://python-poetry.org/) for Python package and environment management. - -## Frontend Requirements - -- Node.js (with `npm`). - -## Backend local development - -- Start the stack with Docker Compose: - -```bash -docker-compose up -d -``` - -- Now you can open your browser and interact with these URLs: - -Frontend, built with Docker, with routes handled based on the path: http://localhost - -Backend, JSON based web API based on OpenAPI: http://localhost/api/ - -Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs - -Alternative automatic documentation with ReDoc (from the OpenAPI backend): http://localhost/redoc - -PGAdmin, PostgreSQL web administration: http://localhost:5050 - -Flower, administration of Celery tasks: http://localhost:5555 - -Traefik UI, to see how the routes are being handled by the proxy: http://localhost:8090 - -**Note**: The first time you start your stack, it might take a minute for it to be ready. While the backend waits for the database to be ready and configures everything. You can check the logs to monitor it. - -To check the logs, run: - -```bash -docker-compose logs -``` - -To check the logs of a specific service, add the name of the service, e.g.: - -```bash -docker-compose logs backend -``` - -If your Docker is not running in `localhost` (the URLs above wouldn't work) check the sections below on **Development with Docker Toolbox** and **Development with a custom IP**. - -## Backend local development, additional details - -### General workflow - -By default, the dependencies are managed with [Poetry](https://python-poetry.org/), go there and install it. - -From `./backend/app/` you can install all the dependencies with: - -```console -$ poetry install -``` - -Then you can start a shell session with the new environment with: - -```console -$ poetry shell -``` - -Next, open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc. Make sure your editor uses the environment you just created with Poetry. - -Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. - -If you need to install any additional package to the worker, add it to the file `./backend/app/celeryworker.dockerfile`. - -### Docker Compose Override - -During development, you can change Docker Compose settings that will only affect the local development environment, in the file `docker-compose.override.yml`. - -The changes to that file only affect the local development environment, not the production environment. So, you can add "temporary" changes that help the development workflow. - -For example, the directory with the backend code is mounted as a Docker "host volume", mapping the code you change live to the directory inside the container. That allows you to test your changes right away, without having to build the Docker image again. It should only be done during development, for production, you should build the Docker image with a recent version of the backend code. But during development, it allows you to iterate very fast. - -There is also a command override that runs `/start-reload.sh` (included in the base image) instead of the default `/start.sh` (also included in the base image). It starts a single server process (instead of multiple, as would be for production) and reloads the process whenever the code changes. Have in mind that if you have a syntax error and save the Python file, it will break and exit, and the container will stop. After that, you can restart the container by fixing the error and running again: - -```console -$ docker-compose up -d -``` - -There is also a commented out `command` override, you can uncomment it and comment the default one. It makes the backend container run a process that does "nothing", but keeps the container alive. That allows you to get inside your running container and execute commands inside, for example a Python interpreter to test installed dependencies, or start the development server that reloads when it detects changes, or start a Jupyter Notebook session. - -To get inside the container with a `bash` session you can start the stack with: - -```console -$ docker-compose up -d -``` - -and then `exec` inside the running container: - -```console -$ docker-compose exec backend bash -``` - -You should see an output like: - -```console -root@7f2607af31c3:/app# -``` - -that means that you are in a `bash` session inside your container, as a `root` user, under the `/app` directory. - -There you can use the script `/start-reload.sh` to run the debug live reloading server. You can run that script from inside the container with: - -```console -$ bash /start-reload.sh -``` - -...it will look like: - -```console -root@7f2607af31c3:/app# bash /start-reload.sh -``` - -and then hit enter. That runs the live reloading server that auto reloads when it detects code changes. - -Nevertheless, if it doesn't detect a change but a syntax error, it will just stop with an error. But as the container is still alive and you are in a Bash session, you can quickly restart it after fixing the error, running the same command ("up arrow" and "Enter"). - -...this previous detail is what makes it useful to have the container alive doing nothing and then, in a Bash session, make it run the live reload server. - -### Backend tests - -To test the backend run: - -```console -$ DOMAIN=backend sh ./scripts/test.sh -``` - -The file `./scripts/test.sh` has the commands to generate a testing `docker-stack.yml` file, start the stack and test it. - -The tests run with Pytest, modify and add tests to `./backend/app/app/tests/`. - -If you use GitLab CI the tests will run automatically. - -#### Local tests - -Start the stack with this command: - -```Bash -DOMAIN=backend sh ./scripts/test-local.sh -``` - -The `./backend/app` directory is mounted as a "host volume" inside the docker container (set in the file `docker-compose.dev.volumes.yml`). -You can rerun the test on live code: - -```Bash -docker-compose exec backend /app/tests-start.sh -``` - -#### Test running stack - -If your stack is already up and you just want to run the tests, you can use: - -```bash -docker-compose exec backend /app/tests-start.sh -``` - -That `/app/tests-start.sh` script just calls `pytest` after making sure that the rest of the stack is running. If you need to pass extra arguments to `pytest`, you can pass them to that command and they will be forwarded. - -For example, to stop on first error: - -```bash -docker-compose exec backend bash /app/tests-start.sh -x -``` - -#### Test Coverage - -Because the test scripts forward arguments to `pytest`, you can enable test coverage HTML report generation by passing `--cov-report=html`. - -To run the local tests with coverage HTML reports: - -```Bash -DOMAIN=backend sh ./scripts/test-local.sh --cov-report=html -``` - -To run the tests in a running stack with coverage HTML reports: - -```bash -docker-compose exec backend bash /app/tests-start.sh --cov-report=html -``` - -### Live development with Python Jupyter Notebooks - -If you know about Python [Jupyter Notebooks](http://jupyter.org/), you can take advantage of them during local development. - -The `docker-compose.override.yml` file sends a variable `env` with a value `dev` to the build process of the Docker image (during local development) and the `Dockerfile` has steps to then install and configure Jupyter inside your Docker container. - -So, you can enter into the running Docker container: - -```bash -docker-compose exec backend bash -``` - -And use the environment variable `$JUPYTER` to run a Jupyter Notebook with everything configured to listen on the public port (so that you can use it from your browser). - -It will output something like: - -```console -root@73e0ec1f1ae6:/app# $JUPYTER -[I 12:02:09.975 NotebookApp] Writing notebook server cookie secret to /root/.local/share/jupyter/runtime/notebook_cookie_secret -[I 12:02:10.317 NotebookApp] Serving notebooks from local directory: /app -[I 12:02:10.317 NotebookApp] The Jupyter Notebook is running at: -[I 12:02:10.317 NotebookApp] http://(73e0ec1f1ae6 or 127.0.0.1):8888/?token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397 -[I 12:02:10.317 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation). -[W 12:02:10.317 NotebookApp] No web browser found: could not locate runnable browser. -[C 12:02:10.317 NotebookApp] - - Copy/paste this URL into your browser when you connect for the first time, - to login with a token: - http://(73e0ec1f1ae6 or 127.0.0.1):8888/?token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397 -``` - -you can copy that URL and modify the "host" to be `localhost` or the domain you are using for development (e.g. `local.dockertoolbox.tiangolo.com`), in the case above, it would be, e.g.: - -``` -http://localhost:8888/token=f20939a41524d021fbfc62b31be8ea4dd9232913476f4397 -``` - -and then open it in your browser. - -You will have a full Jupyter Notebook running inside your container that has direct access to your database by the container name (`db`), etc. So, you can just run sections of your backend code directly, for example with [VS Code Python Jupyter Interactive Window](https://code.visualstudio.com/docs/python/jupyter-support-py) or [Hydrogen](https://github.com/nteract/hydrogen). - -### Development with Docker Toolbox - -If you are using **Docker Toolbox** in Windows or macOS instead of **Docker for Windows** or **Docker for Mac**, Docker will be running in a VirtualBox Virtual Machine, and it will have a local IP different than `127.0.0.1`, which is the IP address for `localhost` in your machine. - -The address of your Docker Toolbox virtual machine would probably be `192.168.99.100` (that is the default). - -As this is a common case, the domain `local.dockertoolbox.tiangolo.com` points to that (private) IP, just to help with development (actually `dockertoolbox.tiangolo.com` and all its subdomains point to that IP). That way, you can start the stack in Docker Toolbox, and use that domain for development. You will be able to open that URL in Chrome and it will communicate with your local Docker Toolbox directly as if it was a cloud server, including CORS (Cross Origin Resource Sharing). - -If you used the default CORS enabled domains while generating the project, `local.dockertoolbox.tiangolo.com` was configured to be allowed. If you didn't, you will need to add it to the list in the variable `BACKEND_CORS_ORIGINS` in the `.env` file. - -To configure it in your stack, follow the section **Change the development "domain"** below, using the domain `local.dockertoolbox.tiangolo.com`. - -After performing those steps you should be able to open: http://local.dockertoolbox.tiangolo.com and it will be server by your stack in your Docker Toolbox virtual machine. - -Check all the corresponding available URLs in the section at the end. - -### Development in `localhost` with a custom domain - -You might want to use something different than `localhost` as the domain. For example, if you are having problems with cookies that need a subdomain, and Chrome is not allowing you to use `localhost`. - -In that case, you have two options: you could use the instructions to modify your system `hosts` file with the instructions below in **Development with a custom IP** or you can just use `localhost.tiangolo.com`, it is set up to point to `localhost` (to the IP `127.0.0.1`) and all its subdomains too. And as it is an actual domain, the browsers will store the cookies you set during development, etc. - -If you used the default CORS enabled domains while generating the project, `localhost.tiangolo.com` was configured to be allowed. If you didn't, you will need to add it to the list in the variable `BACKEND_CORS_ORIGINS` in the `.env` file. - -To configure it in your stack, follow the section **Change the development "domain"** below, using the domain `localhost.tiangolo.com`. - -After performing those steps you should be able to open: http://localhost.tiangolo.com and it will be server by your stack in `localhost`. - -Check all the corresponding available URLs in the section at the end. - -### Development with a custom IP - -If you are running Docker in an IP address different than `127.0.0.1` (`localhost`) and `192.168.99.100` (the default of Docker Toolbox), you will need to perform some additional steps. That will be the case if you are running a custom Virtual Machine, a secondary Docker Toolbox or your Docker is located in a different machine in your network. - -In that case, you will need to use a fake local domain (`dev.grid.openmined.org`) and make your computer think that the domain is is served by the custom IP (e.g. `192.168.99.150`). - -If you used the default CORS enabled domains, `dev.grid.openmined.org` was configured to be allowed. If you want a custom one, you need to add it to the list in the variable `BACKEND_CORS_ORIGINS` in the `.env` file. - -- Open your `hosts` file with administrative privileges using a text editor: - - - **Note for Windows**: If you are in Windows, open the main Windows menu, search for "notepad", right click on it, and select the option "open as Administrator" or similar. Then click the "File" menu, "Open file", go to the directory `c:\Windows\System32\Drivers\etc\`, select the option to show "All files" instead of only "Text (.txt) files", and open the `hosts` file. - - **Note for Mac and Linux**: Your `hosts` file is probably located at `/etc/hosts`, you can edit it in a terminal running `sudo nano /etc/hosts`. - -- Additional to the contents it might have, add a new line with the custom IP (e.g. `192.168.99.150`) a space character, and your fake local domain: `dev.grid.openmined.org`. - -The new line might look like: - -``` -192.168.99.100 dev.grid.openmined.org -``` - -- Save the file. - - **Note for Windows**: Make sure you save the file as "All files", without an extension of `.txt`. By default, Windows tries to add the extension. Make sure the file is saved as is, without extension. - -...that will make your computer think that the fake local domain is served by that custom IP, and when you open that URL in your browser, it will talk directly to your locally running server when it is asked to go to `dev.grid.openmined.org` and think that it is a remote server while it is actually running in your computer. - -To configure it in your stack, follow the section **Change the development "domain"** below, using the domain `dev.grid.openmined.org`. - -After performing those steps you should be able to open: http://dev.grid.openmined.org and it will be server by your stack in `localhost`. - -Check all the corresponding available URLs in the section at the end. - -### Change the development "domain" - -If you need to use your local stack with a different domain than `localhost`, you need to make sure the domain you use points to the IP where your stack is set up. See the different ways to achieve that in the sections above (i.e. using Docker Toolbox with `local.dockertoolbox.tiangolo.com`, using `localhost.tiangolo.com` or using `dev.grid.openmined.org`). - -To simplify your Docker Compose setup, for example, so that the API docs (Swagger UI) knows where is your API, you should let it know you are using that domain for development. You will need to edit 1 line in 2 files. - -- Open the file located at `./.env`. It would have a line like: - -``` -DOMAIN=localhost -``` - -- Change it to the domain you are going to use, e.g.: - -``` -DOMAIN=localhost.tiangolo.com -``` - -That variable will be used by the Docker Compose files. - -- Now open the file located at `./frontend/.env`. It would have a line like: - -``` -VUE_APP_DOMAIN_DEV=localhost -``` - -- Change that line to the domain you are going to use, e.g.: - -``` -VUE_APP_DOMAIN_DEV=localhost.tiangolo.com -``` - -That variable will make your frontend communicate with that domain when interacting with your backend API, when the other variable `VUE_APP_ENV` is set to `development`. - -After changing the two lines, you can re-start your stack with: - -```bash -docker-compose up -d -``` - -and check all the corresponding available URLs in the section at the end. - -## Frontend development - -- Enter the `frontend` directory, install the NPM packages and start the live server using the `npm` scripts: - -```bash -cd frontend -npm install -npm run serve -``` - -Then open your browser at http://localhost:8080 - -Notice that this live server is not running inside Docker, it is for local development, and that is the recommended workflow. Once you are happy with your frontend, you can build the frontend Docker image and start it, to test it in a production-like environment. But compiling the image at every change will not be as productive as running the local development server with live reload. - -Check the file `package.json` to see other available options. - -If you have Vue CLI installed, you can also run `vue ui` to control, configure, serve, and analyze your application using a nice local web user interface. - -If you are only developing the frontend (e.g. other team members are developing the backend) and there is a staging environment already deployed, you can make your local development code use that staging API instead of a full local Docker Compose stack. - -To do that, modify the file `./frontend/.env`, there's a section with: - -``` -VUE_APP_ENV=development -# VUE_APP_ENV=staging -``` - -- Switch the comment, to: - -``` -# VUE_APP_ENV=development -VUE_APP_ENV=staging -``` - -### Removing the frontend - -If you are developing an API-only app and want to remove the frontend, you can do it easily: - -- Remove the `./frontend` directory. -- In the `docker-compose.yml` file, remove the whole service / section `frontend`. -- In the `docker-compose.override.yml` file, remove the whole service / section `frontend`. - -Done, you have a frontend-less (api-only) app. πŸ”₯ πŸš€ - ---- - -If you want, you can also remove the `FRONTEND` environment variables from: - -- `.env` -- `.gitlab-ci.yml` -- `./scripts/*.sh` - -But it would be only to clean them up, leaving them won't really have any effect either way. - -## Deployment - -You can deploy the stack to a Docker Swarm mode cluster with a main Traefik proxy, set up using the ideas from DockerSwarm.rocks, to get automatic HTTPS certificates, etc. - -And you can use CI (continuous integration) systems to do it automatically. - -But you have to configure a couple things first. - -### Traefik network - -This stack expects the public Traefik network to be named `traefik-public`, just as in the tutorials in DockerSwarm.rocks. - -If you need to use a different Traefik public network name, update it in the `docker-compose.yml` files, in the section: - -```YAML -networks: - traefik-public: - external: true -``` - -Change `traefik-public` to the name of the used Traefik network. And then update it in the file `.env`: - -```bash -TRAEFIK_PUBLIC_NETWORK=traefik-public -``` - -### Persisting Docker named volumes - -You need to make sure that each service (Docker container) that uses a volume is always deployed to the same Docker "node" in the cluster, that way it will preserve the data. Otherwise, it could be deployed to a different node each time, and each time the volume would be created in that new node before starting the service. As a result, it would look like your service was starting from scratch every time, losing all the previous data. - -That's specially important for a service running a database. But the same problem would apply if you were saving files in your main backend service (for example, if those files were uploaded by your users, or if they were created by your system). - -To solve that, you can put constraints in the services that use one or more data volumes (like databases) to make them be deployed to a Docker node with a specific label. And of course, you need to have that label assigned to one (only one) of your nodes. - -#### Adding services with volumes - -For each service that uses a volume (databases, services with uploaded files, etc) you should have a label constraint in your `docker-compose.yml` file. - -To make sure that your labels are unique per volume per stack (for example, that they are not the same for `prod` and `stag`) you should prefix them with the name of your stack and then use the same name of the volume. - -Then you need to have those constraints in your `docker-compose.yml` file for the services that need to be fixed with each volume. - -To be able to use different environments, like `prod` and `stag`, you should pass the name of the stack as an environment variable. Like: - -```bash -STACK_NAME=stag-grid-openmined-org sh ./scripts/deploy.sh -``` - -To use and expand that environment variable inside the `docker-compose.yml` files you can add the constraints to the services like: - -```yaml -version: "3" -services: - db: - volumes: - - "app-db-data:/var/lib/postgresql/data/pgdata" - deploy: - placement: - constraints: - - node.labels.${STACK_NAME?Variable not set}.app-db-data == true -``` - -note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing: - -```yaml -version: "3" -services: - db: - volumes: - - "app-db-data:/var/lib/postgresql/data/pgdata" - deploy: - placement: - constraints: - - node.labels.grid-openmined-org.app-db-data == true -``` - -**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`". - -If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume. - -Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically. - -#### `docker-auto-labels` - -You can use [`docker-auto-labels`](https://github.com/tiangolo/docker-auto-labels) to automatically read the placement constraint labels in your Docker stack (Docker Compose file) and assign them to a random Docker node in your Swarm mode cluster if those labels don't exist yet. - -To do that, you can install `docker-auto-labels`: - -```bash -pip install docker-auto-labels -``` - -And then run it passing your `docker-stack.yml` file as a parameter: - -```bash -docker-auto-labels docker-stack.yml -``` - -You can run that command every time you deploy, right before deploying, as it doesn't modify anything if the required labels already exist. - -#### (Optionally) adding labels manually - -If you don't want to use `docker-auto-labels` or for any reason you want to manually assign the constraint labels to specific nodes in your Docker Swarm mode cluster, you can do the following: - -- First, connect via SSH to your Docker Swarm mode cluster. - -- Then check the available nodes with: - -```console -$ docker node ls - - -// you would see an output like: - -ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS -nfa3d4df2df34as2fd34230rm * dog.example.com Ready Active Reachable -2c2sd2342asdfasd42342304e cat.example.com Ready Active Leader -c4sdf2342asdfasd4234234ii snake.example.com Ready Active Reachable -``` - -then chose a node from the list. For example, `dog.example.com`. - -- Add the label to that node. Use as label the name of the stack you are deploying followed by a dot (`.`) followed by the named volume, and as value, just `true`, e.g.: - -```bash -docker node update --label-add grid-openmined-org.app-db-data=true dog.example.com -``` - -- Then you need to do the same for each stack version you have. For example, for staging you could do: - -```bash -docker node update --label-add stag-grid-openmined-org.app-db-data=true cat.example.com -``` - -### Deploy to a Docker Swarm mode cluster - -There are 3 steps: - -1. **Build** your app images -2. Optionally, **push** your custom images to a Docker Registry -3. **Deploy** your stack - ---- - -Here are the steps in detail: - -1. **Build your app images** - -- Set these environment variables, right before the next command: - - `TAG=prod` - - `FRONTEND_ENV=production` -- Use the provided `scripts/build.sh` file with those environment variables: - -```bash -TAG=prod FRONTEND_ENV=production bash ./scripts/build.sh -``` - -2. **Optionally, push your images to a Docker Registry** - -**Note**: if the deployment Docker Swarm mode "cluster" has more than one server, you will have to push the images to a registry or build the images in each server, so that when each of the servers in your cluster tries to start the containers it can get the Docker images for them, pulling them from a Docker Registry or because it has them already built locally. - -If you are using a registry and pushing your images, you can omit running the previous script and instead using this one, in a single shot. - -- Set these environment variables: - - `TAG=prod` - - `FRONTEND_ENV=production` -- Use the provided `scripts/build-push.sh` file with those environment variables: - -```bash -TAG=prod FRONTEND_ENV=production bash ./scripts/build-push.sh -``` - -3. **Deploy your stack** - -- Set these environment variables: - - `DOMAIN=grid.openmined.org` - - `TRAEFIK_TAG=grid.openmined.org` - - `STACK_NAME=grid-openmined-org` - - `TAG=prod` -- Use the provided `scripts/deploy.sh` file with those environment variables: - -```bash -DOMAIN=grid.openmined.org \ -TRAEFIK_TAG=grid.openmined.org \ -STACK_NAME=grid-openmined-org \ -TAG=prod \ -bash ./scripts/deploy.sh -``` - ---- - -If you change your mind and, for example, want to deploy everything to a different domain, you only have to change the `DOMAIN` environment variable in the previous commands. If you wanted to add a different version / environment of your stack, like "`preproduction`", you would only have to set `TAG=preproduction` in your command and update these other environment variables accordingly. And it would all work, that way you could have different environments and deployments of the same app in the same cluster. - -#### Deployment Technical Details - -Building and pushing is done with the `docker-compose.yml` file, using the `docker-compose` command. The file `docker-compose.yml` uses the file `.env` with default environment variables. And the scripts set some additional environment variables as well. - -The deployment requires using `docker stack` instead of `docker-swarm`, and it can't read environment variables or `.env` files. Because of that, the `deploy.sh` script generates a file `docker-stack.yml` with the configurations from `docker-compose.yml` and injecting the environment variables in it. And then uses it to deploy the stack. - -You can do the process by hand based on those same scripts if you wanted. The general structure is like this: - -```bash -# Use the environment variables passed to this script, as TAG and FRONTEND_ENV -# And re-create those variables as environment variables for the next command -TAG=${TAG?Variable not set} \ -# Set the environment variable FRONTEND_ENV to the same value passed to this script with -# a default value of "production" if nothing else was passed -FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \ -# The actual comand that does the work: docker-compose -docker-compose \ -# Pass the file that should be used, setting explicitly docker-compose.yml avoids the -# default of also using docker-compose.override.yml --f docker-compose.yml \ -# Use the docker-compose sub command named "config", it just uses the docker-compose.yml -# file passed to it and prints their combined contents -# Put those contents in a file "docker-stack.yml", with ">" -config > docker-stack.yml - -# The previous only generated a docker-stack.yml file, -# but didn't do anything with it yet - -# docker-auto-labels makes sure the labels used for constraints exist in the cluster -docker-auto-labels docker-stack.yml - -# Now this command uses that same file to deploy it -docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}" -``` - -### Continuous Integration / Continuous Delivery - -If you use GitLab CI, the included `.gitlab-ci.yml` can automatically deploy it. You may need to update it according to your GitLab configurations. - -If you use any other CI / CD provider, you can base your deployment from that `.gitlab-ci.yml` file, as all the actual script steps are performed in `bash` scripts that you can easily re-use. - -GitLab CI is configured assuming 2 environments following GitLab flow: - -- `prod` (production) from the `production` branch. -- `stag` (staging) from the `master` branch. - -If you need to add more environments, for example, you could imagine using a client-approved `preprod` branch, you can just copy the configurations in `.gitlab-ci.yml` for `stag` and rename the corresponding variables. The Docker Compose file and environment variables are configured to support as many environments as you need, so that you only need to modify `.gitlab-ci.yml` (or whichever CI system configuration you are using). - -## Docker Compose files and env vars - -There is a main `docker-compose.yml` file with all the configurations that apply to the whole stack, it is used automatically by `docker-compose`. - -And there's also a `docker-compose.override.yml` with overrides for development, for example to mount the source code as a volume. It is used automatically by `docker-compose` to apply overrides on top of `docker-compose.yml`. - -These Docker Compose files use the `.env` file containing configurations to be injected as environment variables in the containers. - -They also use some additional configurations taken from environment variables set in the scripts before calling the `docker-compose` command. - -It is all designed to support several "stages", like development, building, testing, and deployment. Also, allowing the deployment to different environments like staging and production (and you can add more environments very easily). - -They are designed to have the minimum repetition of code and configurations, so that if you need to change something, you have to change it in the minimum amount of places. That's why files use environment variables that get auto-expanded. That way, if for example, you want to use a different domain, you can call the `docker-compose` command with a different `DOMAIN` environment variable instead of having to change the domain in several places inside the Docker Compose files. - -Also, if you want to have another deployment environment, say `preprod`, you just have to change environment variables, but you can keep using the same Docker Compose files. - -### The .env file - -The `.env` file is the one that contains all your configurations, generated keys and passwords, etc. - -Depending on your workflow, you could want to exclude it from Git, for example if your project is public. In that case, you would have to make sure to set up a way for your CI tools to obtain it while building or deploying your project. - -One way to do it could be to add each environment variable to your CI/CD system, and updating the `docker-compose.yml` file to read that specific env var instead of reading the `.env` file. - -## URLs - -These are the URLs that will be used and generated by the project. - -### Production URLs - -Production URLs, from the branch `production`. - -Frontend: https://grid.openmined.org - -Backend: https://grid.openmined.org/api/ - -Automatic Interactive Docs (Swagger UI): https://grid.openmined.org/docs - -Automatic Alternative Docs (ReDoc): https://grid.openmined.org/redoc - -PGAdmin: https://pgadmin.grid.openmined.org - -Flower: https://flower.grid.openmined.org - -### Staging URLs - -Staging URLs, from the branch `master`. - -Frontend: https://stag.grid.openmined.org - -Backend: https://stag.grid.openmined.org/api/ - -Automatic Interactive Docs (Swagger UI): https://stag.grid.openmined.org/docs - -Automatic Alternative Docs (ReDoc): https://stag.grid.openmined.org/redoc - -PGAdmin: https://pgadmin.stag.grid.openmined.org - -Flower: https://flower.stag.grid.openmined.org - -### Development URLs - -Development URLs, for local development. - -Frontend: http://localhost - -Backend: http://localhost/api/ - -Automatic Interactive Docs (Swagger UI): https://localhost/docs - -Automatic Alternative Docs (ReDoc): https://localhost/redoc - -PGAdmin: http://localhost:5050 - -Flower: http://localhost:5555 - -Traefik UI: http://localhost:8090 - -### Development with Docker Toolbox URLs - -Development URLs, for local development. - -Frontend: http://local.dockertoolbox.tiangolo.com - -Backend: http://local.dockertoolbox.tiangolo.com/api/ - -Automatic Interactive Docs (Swagger UI): https://local.dockertoolbox.tiangolo.com/docs - -Automatic Alternative Docs (ReDoc): https://local.dockertoolbox.tiangolo.com/redoc - -PGAdmin: http://local.dockertoolbox.tiangolo.com:5050 - -Flower: http://local.dockertoolbox.tiangolo.com:5555 - -Traefik UI: http://local.dockertoolbox.tiangolo.com:8090 - -### Development with a custom IP URLs - -Development URLs, for local development. - -Frontend: http://dev.grid.openmined.org - -Backend: http://dev.grid.openmined.org/api/ - -Automatic Interactive Docs (Swagger UI): https://dev.grid.openmined.org/docs - -Automatic Alternative Docs (ReDoc): https://dev.grid.openmined.org/redoc - -PGAdmin: http://dev.grid.openmined.org:5050 - -Flower: http://dev.grid.openmined.org:5555 - -Traefik UI: http://dev.grid.openmined.org:8090 - -### Development in localhost with a custom domain URLs - -Development URLs, for local development. - -Frontend: http://localhost.tiangolo.com - -Backend: http://localhost.tiangolo.com/api/ - -Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs - -Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc - -PGAdmin: http://localhost.tiangolo.com:5050 - -Flower: http://localhost.tiangolo.com:5555 - -Traefik UI: http://localhost.tiangolo.com:8090 - -## Project generation and updating, or re-generating - -This project was generated using https://github.com/tiangolo/full-stack-fastapi-postgresql with: - -```bash -pip install cookiecutter -cookiecutter https://github.com/tiangolo/full-stack-fastapi-postgresql -``` - -You can check the variables used during generation in the file `cookiecutter-config-file.yml`. - -You can generate the project again with the same configurations used the first time. - -That would be useful if, for example, the project generator (`tiangolo/full-stack-fastapi-postgresql`) was updated and you wanted to integrate or review the changes. - -You could generate a new project with the same configurations as this one in a parallel directory. And compare the differences between the two, without having to overwrite your current code but being able to use the same variables used for your current project. - -To achieve that, the generated project includes the file `cookiecutter-config-file.yml` with the current variables used. - -You can use that file while generating a new project to reuse all those variables. - -For example, run: - -```console -$ cookiecutter --config-file ./cookiecutter-config-file.yml --output-dir ../project-copy https://github.com/tiangolo/full-stack-fastapi-postgresql -``` - -That will use the file `cookiecutter-config-file.yml` in the current directory (in this project) to generate a new project inside a sibling directory `project-copy`. diff --git a/packages/grid/docker-compose.build.yml b/packages/grid/docker-compose.build.yml deleted file mode 100644 index 7dc60d3fe41..00000000000 --- a/packages/grid/docker-compose.build.yml +++ /dev/null @@ -1,24 +0,0 @@ -version: "3.8" -services: - frontend: - build: - context: ${RELATIVE_PATH}./frontend - dockerfile: frontend.dockerfile - target: "${FRONTEND_TARGET:-grid-ui-development}" - - backend: - build: - context: ${RELATIVE_PATH}../ - dockerfile: ./grid/backend/backend.dockerfile - target: "backend" - - seaweedfs: - build: - context: ${RELATIVE_PATH}./seaweedfs - dockerfile: seaweedfs.dockerfile - - worker: - build: - context: ${RELATIVE_PATH}../ - dockerfile: ./grid/backend/backend.dockerfile - target: "backend" diff --git a/packages/grid/docker-compose.dev.yml b/packages/grid/docker-compose.dev.yml deleted file mode 100644 index d2b1f142053..00000000000 --- a/packages/grid/docker-compose.dev.yml +++ /dev/null @@ -1,77 +0,0 @@ -version: "3.8" -services: - proxy: - ports: - - "8080" - command: - - "--api" # admin panel - - "--api.insecure=true" # admin panel no password - - frontend: - volumes: - - ${RELATIVE_PATH}./frontend/src:/app/src - - ${RELATIVE_PATH}./frontend/static:/app/static - - ${RELATIVE_PATH}./frontend/svelte.config.js:/app/svelte.config.js - - ${RELATIVE_PATH}./frontend/tsconfig.json:/app/tsconfig.json - - ${RELATIVE_PATH}./frontend/vite.config.ts:/app/vite.config.ts - environment: - - FRONTEND_TARGET=grid-ui-development - - # redis: - # ports: - # - "6379" - - # queue: - # image: rabbitmq:3-management - # ports: - # - "15672" # admin web port - # # - "5672" # AMQP port - - mongo: - ports: - - "27017" - - backend: - volumes: - - ${RELATIVE_PATH}./backend/grid:/root/app/grid - - ${RELATIVE_PATH}../syft:/root/app/syft - - ${RELATIVE_PATH}./data/package-cache:/root/.cache - environment: - - DEV_MODE=True - stdin_open: true - tty: true - - worker: - volumes: - - ${RELATIVE_PATH}./backend/grid:/root/app/grid - - ${RELATIVE_PATH}../syft:/root/app/syft - - ${RELATIVE_PATH}./data/package-cache:/root/.cache - environment: - - DEV_MODE=True - - WATCHFILES_FORCE_POLLING=true - stdin_open: true - tty: true - - # backend_stream: - # volumes: - # - ${RELATIVE_PATH}./backend/grid:/root/app/grid - # - ${RELATIVE_PATH}../syft:/root/app/syft - # - ${RELATIVE_PATH}./data/package-cache:/root/.cache - # environment: - # - DEV_MODE=True - - # celeryworker: - # volumes: - # - ${RELATIVE_PATH}./backend/grid:/root/app/grid - # - ${RELATIVE_PATH}../syft/:/root/app/syft - # - ${RELATIVE_PATH}./data/package-cache:/root/.cache - # environment: - # - DEV_MODE=True - - seaweedfs: - volumes: - - ./data/seaweedfs:/data - ports: - - "9333" # admin web port - - "8888" # filer web port - - "8333" # S3 API port diff --git a/packages/grid/docker-compose.pull.yml b/packages/grid/docker-compose.pull.yml deleted file mode 100644 index db2329b04df..00000000000 --- a/packages/grid/docker-compose.pull.yml +++ /dev/null @@ -1,26 +0,0 @@ -version: "3.8" -services: - # redis: - # image: redis:${REDIS_VERSION?Variable not set} - - # queue: - # image: rabbitmq:${RABBITMQ_VERSION?Variable not Set}${RABBITMQ_MANAGEMENT:-} - - seaweedfs: - image: "${DOCKER_IMAGE_SEAWEEDFS?Variable not set}:${VERSION-latest}" - - # docker-host: - # image: qoomon/docker-host - - proxy: - image: ${DOCKER_IMAGE_TRAEFIK?Variable not set}:${TRAEFIK_VERSION?Variable not set} - - mongo: - image: "${MONGO_IMAGE}:${MONGO_VERSION}" - - jaeger: - image: jaegertracing/all-in-one:1.37 - - # Temporary fix until we refactor pull, build, launch UI step during hagrid launch - worker: - image: "${DOCKER_IMAGE_BACKEND?Variable not set}:${VERSION-latest}" diff --git a/packages/grid/docker-compose.test.yml b/packages/grid/docker-compose.test.yml deleted file mode 100644 index a9e323831bb..00000000000 --- a/packages/grid/docker-compose.test.yml +++ /dev/null @@ -1,37 +0,0 @@ -version: "3.8" -services: - proxy: - ports: - - "8080" - - # redis: - # ports: - # - "6379" - - # queue: - # image: rabbitmq:3-management - # ports: - # - "5672" - # - "15672" - - seaweedfs: - ports: - - "9333" # admin - - "8888" # filer - - "8333" # S3 - - backend: - environment: - - TEST_MODE=1 - - worker: - environment: - - TEST_MODE=1 - - # backend_stream: - # environment: - # - TEST_MODE=1 - - # celeryworker: - # environment: - # - TEST_MODE=1 diff --git a/packages/grid/docker-compose.tls.yml b/packages/grid/docker-compose.tls.yml deleted file mode 100644 index 6bfa5d7d1d7..00000000000 --- a/packages/grid/docker-compose.tls.yml +++ /dev/null @@ -1,14 +0,0 @@ -version: "3.8" -services: - proxy: - ports: - - "${HTTPS_PORT}:${HTTPS_PORT}" - environment: - - TRAEFIK_TLS_CONF=${TRAEFIK_TLS_CONF} - - TRAEFIK_TLS_CERTS=${TRAEFIK_TLS_CERTS} - volumes: - - "${TRAEFIK_TLS_CONF}:/etc/traefik/conf/certs.yaml" - - "${TRAEFIK_TLS_CERTS}:/etc/traefik/certs" - - "./traefik/docker/traefik-tls.template.yml:/etc/traefik/traefik-tls.template.yml" - - "./traefik/docker/dynamic-tls.yml:/etc/traefik/conf/dynamic.yml" - command: /bin/ash -c "apk add gettext && envsubst < /etc/traefik/traefik-tls.template.yml > /etc/traefik/traefik-tls.yml && traefik --configFile=/etc/traefik/traefik-tls.yml" diff --git a/packages/grid/docker-compose.yml b/packages/grid/docker-compose.yml deleted file mode 100644 index c7a2bb7e709..00000000000 --- a/packages/grid/docker-compose.yml +++ /dev/null @@ -1,314 +0,0 @@ -version: "3.8" -services: - # docker-host: - # image: qoomon/docker-host - # cap_add: - # - net_admin - # - net_raw - - proxy: - restart: always - hostname: ${NODE_NAME?Variable not set} - image: ${DOCKER_IMAGE_TRAEFIK?Variable not set}:${TRAEFIK_VERSION?Variable not set} - profiles: - - proxy - networks: - - "${TRAEFIK_PUBLIC_NETWORK?Variable not set}" - - default - volumes: - - "./traefik/docker/traefik.yml:/etc/traefik/traefik.yml" - - "./traefik/docker/dynamic.yml:/etc/traefik/conf/dynamic.yml" - environment: - - SERVICE_NAME=proxy - - RELEASE=${RELEASE:-production} - - HOSTNAME=${NODE_NAME?Variable not set} - - HTTP_PORT=${HTTP_PORT} - - HTTPS_PORT=${HTTPS_PORT} - ports: - - "${HTTP_PORT}:81" - extra_hosts: - - "host.docker.internal:host-gateway" - labels: - - "orgs.openmined.syft=this is a syft proxy container" - - # depends_on: - # - "docker-host" - - frontend: - restart: always - image: "${DOCKER_IMAGE_FRONTEND?Variable not set}:${VERSION-latest}" - profiles: - - frontend - depends_on: - - proxy - environment: - - SERVICE_NAME=frontend - - RELEASE=${RELEASE:-production} - - NODE_TYPE=${NODE_TYPE?Variable not set} - - FRONTEND_TARGET=${FRONTEND_TARGET} - - VERSION=${VERSION} - - VERSION_HASH=${VERSION_HASH} - - PORT=80 - - HTTP_PORT=${HTTP_PORT} - - HTTPS_PORT=${HTTPS_PORT} - - BACKEND_API_BASE_URL=${BACKEND_API_BASE_URL} - extra_hosts: - - "host.docker.internal:host-gateway" - labels: - - "orgs.openmined.syft=this is a syft frontend container" - - # redis: - # restart: always - # image: redis:${REDIS_VERSION?Variable not set} - # volumes: - # - app-redis-data:/data - # - ./redis/redis.conf:/usr/local/etc/redis/redis.conf - # environment: - # - SERVICE_NAME=redis - # - RELEASE=${RELEASE:-production} - # env_file: - # - .env - - # queue: - # restart: always - # image: rabbitmq:3 - # environment: - # - SERVICE_NAME=queue - # - RELEASE=${RELEASE:-production} - # volumes: - # - ./rabbitmq/rabbitmq.conf:/etc/rabbitmq/rabbitmq.conf - - worker: - restart: always - image: "${DOCKER_IMAGE_BACKEND?Variable not set}:${VERSION-latest}" - hostname: ${NODE_NAME?Variable not set} - profiles: - - worker - env_file: - - .env - environment: - - SERVICE_NAME=worker - - RELEASE=${RELEASE:-production} - - VERSION=${VERSION} - - VERSION_HASH=${VERSION_HASH} - - NODE_TYPE=${NODE_TYPE?Variable not set} - - NODE_NAME=${NODE_NAME?Variable not set} - - STACK_API_KEY=${STACK_API_KEY} - - PORT=${HTTP_PORT} - - IGNORE_TLS_ERRORS=${IGNORE_TLS_ERRORS?False} - - HTTP_PORT=${HTTP_PORT} - - HTTPS_PORT=${HTTPS_PORT} - - USE_BLOB_STORAGE=${USE_BLOB_STORAGE} - - CONTAINER_HOST=${CONTAINER_HOST} - - TRACE=False # TODO: Trace Mode is set to False, until jaegar is integrated - - JAEGER_HOST=${JAEGER_HOST} - - JAEGER_PORT=${JAEGER_PORT} - - ASSOCIATION_TIMEOUT=${ASSOCIATION_TIMEOUT} - - DEV_MODE=${DEV_MODE} - - QUEUE_PORT=${QUEUE_PORT} - - CREATE_PRODUCER=true - - NODE_SIDE_TYPE=${NODE_SIDE_TYPE} - - ENABLE_WARNINGS=${ENABLE_WARNINGS} - - INMEMORY_WORKERS=True # hardcoding is intentional, since single_container don't share databases - ports: - - "${HTTP_PORT}:${HTTP_PORT}" - volumes: - - credentials-data:/root/data/creds/ - - /var/run/docker.sock:/var/run/docker.sock - extra_hosts: - - "host.docker.internal:host-gateway" - labels: - - "orgs.openmined.syft=this is a syft worker container" - - backend: - restart: always - image: "${DOCKER_IMAGE_BACKEND?Variable not set}:${VERSION-latest}" - profiles: - - backend - depends_on: - - proxy - - mongo - env_file: - - .env - environment: - - SERVICE_NAME=backend - - RELEASE=${RELEASE:-production} - - VERSION=${VERSION} - - VERSION_HASH=${VERSION_HASH} - - NODE_TYPE=${NODE_TYPE?Variable not set} - - NODE_NAME=${NODE_NAME?Variable not set} - - STACK_API_KEY=${STACK_API_KEY} - - PORT=8001 - - IGNORE_TLS_ERRORS=${IGNORE_TLS_ERRORS?False} - - HTTP_PORT=${HTTP_PORT} - - HTTPS_PORT=${HTTPS_PORT} - - USE_BLOB_STORAGE=${USE_BLOB_STORAGE} - - CONTAINER_HOST=${CONTAINER_HOST} - - TRACE=${TRACE} - - JAEGER_HOST=${JAEGER_HOST} - - JAEGER_PORT=${JAEGER_PORT} - - ASSOCIATION_TIMEOUT=${ASSOCIATION_TIMEOUT} - - DEV_MODE=${DEV_MODE} - - DEFAULT_ROOT_EMAIL=${DEFAULT_ROOT_EMAIL} - - DEFAULT_ROOT_PASSWORD=${DEFAULT_ROOT_PASSWORD} - - QUEUE_PORT=${QUEUE_PORT} - - CREATE_PRODUCER=true - - N_CONSUMERS=1 - - INMEMORY_WORKERS=${INMEMORY_WORKERS} - - HOST_GRID_PATH=${PWD} - command: "./grid/start.sh" - network_mode: service:proxy - volumes: - - ${CREDENTIALS_VOLUME}:/root/data/creds/ - - /var/run/docker.sock:/var/run/docker.sock - stdin_open: true - tty: true - labels: - - "orgs.openmined.syft=this is a syft backend container" - - # backend_stream: - # restart: always - # image: "${DOCKER_IMAGE_BACKEND?Variable not set}:${VERSION-latest}" - # depends_on: - # - proxy - # env_file: - # - .env - # environment: - # - SERVICE_NAME=backend_stream - # - RELEASE=${RELEASE:-production} - # - VERSION=${VERSION} - # - VERSION_HASH=${VERSION_HASH} - # - NODE_TYPE=${NODE_TYPE?Variable not set} - # - DOMAIN_NAME=${DOMAIN_NAME?Variable not set} - # - STACK_API_KEY=${STACK_API_KEY} - # - PORT=8011 - # - STREAM_QUEUE=1 - # - IGNORE_TLS_ERRORS=${IGNORE_TLS_ERRORS?False} - # - HTTP_PORT=${HTTP_PORT} - # - HTTPS_PORT=${HTTPS_PORT} - # - USE_BLOB_STORAGE=${USE_BLOB_STORAGE} - # - CONTAINER_HOST=${CONTAINER_HOST} - # - TRACE=${TRACE} - # - JAEGER_HOST=${JAEGER_HOST} - # - JAEGER_PORT=${JAEGER_PORT} - # - DEV_MODE=${DEV_MODE} - # network_mode: service:proxy - # volumes: - # - credentials-data:/root/data/creds/ - - # celeryworker: - # restart: always - # image: "${DOCKER_IMAGE_BACKEND?Variable not set}:${VERSION-latest}" - # depends_on: - # - proxy - # - queue - # env_file: - # - .env - # environment: - # - SERVICE_NAME=celeryworker - # - RELEASE=${RELEASE:-production} - # - VERSION=${VERSION} - # - VERSION_HASH=${VERSION_HASH} - # - NODE_TYPE=${NODE_TYPE?Variable not set} - # - DOMAIN_NAME=${DOMAIN_NAME?Variable not set} - # - C_FORCE_ROOT=1 - # - STACK_API_KEY=${STACK_API_KEY} - # - IGNORE_TLS_ERRORS=${IGNORE_TLS_ERRORS?False} - # - HTTP_PORT=${HTTP_PORT} - # - HTTPS_PORT=${HTTPS_PORT} - # - USE_BLOB_STORAGE=${USE_BLOB_STORAGE} - # - CONTAINER_HOST=${CONTAINER_HOST} - # - NETWORK_CHECK_INTERVAL=${NETWORK_CHECK_INTERVAL} - # - DOMAIN_CHECK_INTERVAL=${DOMAIN_CHECK_INTERVAL} - # - TRACE=${TRACE} - # - JAEGER_HOST=${JAEGER_HOST} - # - JAEGER_PORT=${JAEGER_PORT} - # - DEV_MODE=${DEV_MODE} - # command: "/app/grid/worker-start.sh" - # network_mode: service:proxy - # volumes: - # - credentials-data:/storage - - seaweedfs: - profiles: - - blob-storage - depends_on: - - proxy - env_file: - - .env - image: "${DOCKER_IMAGE_SEAWEEDFS?Variable not set}:${VERSION-latest}" - environment: - - SWFS_VOLUME_SIZE_LIMIT_MB=${SWFS_VOLUME_SIZE_LIMIT_MB:-1000} - - S3_ROOT_USER=${S3_ROOT_USER:-admin} - - S3_ROOT_PWD=${S3_ROOT_PWD:-admin} - - MOUNT_API_PORT=${MOUNT_API_PORT:-4001} - volumes: - - seaweedfs-data:/data - labels: - - "orgs.openmined.syft=this is a syft seaweedfs container" - - mongo: - image: "${MONGO_IMAGE}:${MONGO_VERSION}" - profiles: - - mongo - restart: always - environment: - - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME} - - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD} - volumes: - - mongo-data:/data/db - - mongo-config-data:/data/configdb - labels: - - "orgs.openmined.syft=this is a syft mongo container" - - jaeger: - profiles: - - telemetry - image: jaegertracing/all-in-one:1.37 - environment: - - COLLECTOR_ZIPKIN_HOST_PORT=9411 - - COLLECTOR_OTLP_ENABLED=true - extra_hosts: - - "host.docker.internal:host-gateway" - ports: - - "${JAEGER_PORT}:14268" # http collector - - "16686" # ui - # - "6831:6831/udp" - # - "6832:6832/udp" - # - "5778:5778" - # - "4317:4317" - # - "4318:4318" - # - "14250:14250" - # - "14269:14269" - # - "9411:9411" - volumes: - - jaeger-data:/tmp - labels: - - "orgs.openmined.syft=this is a syft jaeger container" - -volumes: - credentials-data: - labels: - orgs.openmined.syft: "this is a syft credentials volume" - seaweedfs-data: - labels: - orgs.openmined.syft: "this is a syft seaweedfs volume" - mongo-data: - labels: - orgs.openmined.syft: "this is a syft mongo volume" - mongo-config-data: - labels: - orgs.openmined.syft: "this is a syft mongo volume" - jaeger-data: - labels: - orgs.openmined.syft: "this is a syft jaeger volume" - -networks: - traefik-public: - # Allow setting it to false for testing - external: ${TRAEFIK_PUBLIC_NETWORK_IS_EXTERNAL-true} - labels: - orgs.openmined.syft: "this is a syft traefik public network" - default: - labels: - orgs.openmined.syft: "this is a syft default network" From e6c40b64ecd30bcd6f6c0004b5e50df657f23e5f Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:19:39 +0530 Subject: [PATCH 12/15] remove old scripts --- packages/grid/scripts/deploy.sh | 16 ---------------- packages/grid/scripts/rc.local.j2 | 9 --------- packages/grid/scripts/start_notebook.sh | 2 -- packages/grid/scripts/test-local.sh | 15 --------------- packages/grid/scripts/test.sh | 17 ----------------- 5 files changed, 59 deletions(-) delete mode 100644 packages/grid/scripts/deploy.sh delete mode 100644 packages/grid/scripts/rc.local.j2 delete mode 100755 packages/grid/scripts/start_notebook.sh delete mode 100644 packages/grid/scripts/test-local.sh delete mode 100644 packages/grid/scripts/test.sh diff --git a/packages/grid/scripts/deploy.sh b/packages/grid/scripts/deploy.sh deleted file mode 100644 index 55a86ee94ce..00000000000 --- a/packages/grid/scripts/deploy.sh +++ /dev/null @@ -1,16 +0,0 @@ -#! /usr/bin/env sh - -# Exit in case of error -set -e - -DOMAIN=${DOMAIN?Variable not set} \ -TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \ -STACK_NAME=${STACK_NAME?Variable not set} \ -TAG=${TAG?Variable not set} \ -docker-compose \ --f docker-compose.yml \ -config > docker-stack.yml - -docker-auto-labels docker-stack.yml - -docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}" diff --git a/packages/grid/scripts/rc.local.j2 b/packages/grid/scripts/rc.local.j2 deleted file mode 100644 index 63bfdc410e8..00000000000 --- a/packages/grid/scripts/rc.local.j2 +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/bash - -until systemctl is-active --quiet docker -do - echo "Waiting for docker service to start" - sleep 1 -done - -sudo {{ syft_dir }}/packages/grid/scripts/containers.sh diff --git a/packages/grid/scripts/start_notebook.sh b/packages/grid/scripts/start_notebook.sh deleted file mode 100755 index 648368c0f4d..00000000000 --- a/packages/grid/scripts/start_notebook.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -docker-compose exec backend bash -c \$JUPYTER diff --git a/packages/grid/scripts/test-local.sh b/packages/grid/scripts/test-local.sh deleted file mode 100644 index 4c180f21d3a..00000000000 --- a/packages/grid/scripts/test-local.sh +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env bash - -# Exit in case of error -set -e - -docker-compose down -v --remove-orphans # Remove possibly previous broken stacks left hanging after an error - -if [ $(uname -s) = "Linux" ]; then - echo "Remove __pycache__ files" - sudo find . -type d -name __pycache__ -exec rm -r {} \+ -fi - -docker-compose build -docker-compose up -d -docker-compose exec -T backend bash /app/tests-start.sh "$@" diff --git a/packages/grid/scripts/test.sh b/packages/grid/scripts/test.sh deleted file mode 100644 index 78b4db90e05..00000000000 --- a/packages/grid/scripts/test.sh +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env sh - -# Exit in case of error -set -e - -DOMAIN=backend \ -SMTP_HOST="" \ -TRAEFIK_PUBLIC_NETWORK_IS_EXTERNAL=false \ -docker-compose \ --f docker-compose.yml \ -config > docker-stack.yml - -docker-compose -f docker-stack.yml build -docker-compose -f docker-stack.yml down -v --remove-orphans # Remove possibly previous broken stacks left hanging after an error -docker-compose -f docker-stack.yml up -d -docker-compose -f docker-stack.yml exec -T backend bash /app/tests-start.sh "$@" -docker-compose -f docker-stack.yml down -v --remove-orphans From 4d88af9d4bee2cc9b478afdb9d41f22f4cf02547 Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:25:54 +0530 Subject: [PATCH 13/15] removed additional references of compose --- packages/syftcli/manifest.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/packages/syftcli/manifest.yml b/packages/syftcli/manifest.yml index a2224cec8a2..484edf23331 100644 --- a/packages/syftcli/manifest.yml +++ b/packages/syftcli/manifest.yml @@ -12,12 +12,6 @@ images: configFiles: docker: - packages/grid/default.env - - packages/grid/docker-compose.build.yml - - packages/grid/docker-compose.dev.yml - - packages/grid/docker-compose.pull.yml - - packages/grid/docker-compose.test.yml - - packages/grid/docker-compose.tls.yml - - packages/grid/docker-compose.yml - packages/grid/traefik/docker/dynamic-tls.yml - packages/grid/traefik/docker/dynamic.yml - packages/grid/traefik/docker/traefik-tls.template.yml From 9f81500b02df64b92c2e25cd33c3c4f2adadf94f Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:35:45 +0530 Subject: [PATCH 14/15] remove gevent serialization --- packages/syft/src/syft/serde/third_party.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/packages/syft/src/syft/serde/third_party.py b/packages/syft/src/syft/serde/third_party.py index 17640434b1f..c28efa6036a 100644 --- a/packages/syft/src/syft/serde/third_party.py +++ b/packages/syft/src/syft/serde/third_party.py @@ -26,7 +26,6 @@ from result import Err from result import Ok from result import Result -import zmq.green as zmq # relative from ..types.dicttuple import DictTuple @@ -198,15 +197,6 @@ def serialize_bytes_io(io: BytesIO) -> bytes: deserialize=lambda x: pydantic.EmailStr(x.decode()), ) -recursive_serde_register( - zmq._Socket, - serialize_attrs=[ - "_shadow", - "_monitor_socket", - "_type_name", - ], -) -recursive_serde_register(zmq._Context) # how else do you import a relative file to execute it? NOTHING = None From c3182719cbed76fc93cbf2c11323f89db455627e Mon Sep 17 00:00:00 2001 From: rasswanth-s <43314053+rasswanth-s@users.noreply.github.com> Date: Tue, 21 May 2024 11:39:03 +0530 Subject: [PATCH 15/15] Remove additional gevent references --- packages/syft/src/syft/service/queue/zmq_queue.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/syft/src/syft/service/queue/zmq_queue.py b/packages/syft/src/syft/service/queue/zmq_queue.py index 43a948b2abf..3ad4b732f89 100644 --- a/packages/syft/src/syft/service/queue/zmq_queue.py +++ b/packages/syft/src/syft/service/queue/zmq_queue.py @@ -11,10 +11,10 @@ # third party from loguru import logger from pydantic import field_validator +import zmq from zmq import Frame from zmq import LINGER from zmq.error import ContextTerminated -import zmq.green as zmq # relative from ...serde.deserialize import _deserialize