Added file and container image caching (#4828)
* File and container image downloads are now cached localy, so that repeated vagrant up/down runs do not trigger downloading of those files. This is especially useful on laptops with kubernetes runnig locally on vm's. The total size of the cache, after an ansible run, is currently around 800MB, so bandwidth (=time) savings can be quite significant.
* When download_run_once is false, the default is still not to cache, but setting download_force_cache will still enable caching.
* The local cache location can be set with download_cache_dir and defaults to /tmp/kubernetes_cache
* A local docker instance is no longer required to cache docker images; Images are cached to file. A local docker instance is still required, though, if you wish to download images on localhost.
* Fixed a FIXME, wher the argument was that delegate_to doesn't play nice with omit. That is a correct observation and the fix is to use default(inventory_host) instead of default(omit). See ansible/ansible#26009
* Removed "Register docker images info" task from download_container and set_docker_image_facts because it was faulty and unused.
* Removed redundant when:download.{container,enabled,run_once} conditions from {sync,download}_container.yml
* All features of commit d6fd0d2acaec9f53e75d82db30411f96a5bf2cc9 by Timoses <timosesu@gmail.com>, merged May 1st 2019, are included in this patch. Not all code was included verbatim, but each feature of that commit was checked to be working in this patch. One notable change: The actual downloading of the kubeadm images was moved to {download,sync)_container, to enable caching.
Note 1: I considered splitting this patch, but most changes that are not directly related to caching, are a pleasant by-product of implementing the caching code, so splitting would be impractical.
Note 2: I have my doubts about the usefulness of the upload, download and upgrade tags in the download role. Must they remain or can they be removed? If anybody knows, then please speak up.
2019-06-10 18:21:07 +00:00
|
|
|
---
|
|
|
|
- name: set_container_facts | Display the name of the image being processed
|
|
|
|
debug:
|
|
|
|
msg: "{{ download.repo }}"
|
|
|
|
|
|
|
|
- name: set_container_facts | Set if containers should be pulled by digest
|
|
|
|
set_fact:
|
2021-05-18 13:29:31 +00:00
|
|
|
pull_by_digest: "{{ download.sha256 is defined and download.sha256 }}"
|
Added file and container image caching (#4828)
* File and container image downloads are now cached localy, so that repeated vagrant up/down runs do not trigger downloading of those files. This is especially useful on laptops with kubernetes runnig locally on vm's. The total size of the cache, after an ansible run, is currently around 800MB, so bandwidth (=time) savings can be quite significant.
* When download_run_once is false, the default is still not to cache, but setting download_force_cache will still enable caching.
* The local cache location can be set with download_cache_dir and defaults to /tmp/kubernetes_cache
* A local docker instance is no longer required to cache docker images; Images are cached to file. A local docker instance is still required, though, if you wish to download images on localhost.
* Fixed a FIXME, wher the argument was that delegate_to doesn't play nice with omit. That is a correct observation and the fix is to use default(inventory_host) instead of default(omit). See ansible/ansible#26009
* Removed "Register docker images info" task from download_container and set_docker_image_facts because it was faulty and unused.
* Removed redundant when:download.{container,enabled,run_once} conditions from {sync,download}_container.yml
* All features of commit d6fd0d2acaec9f53e75d82db30411f96a5bf2cc9 by Timoses <timosesu@gmail.com>, merged May 1st 2019, are included in this patch. Not all code was included verbatim, but each feature of that commit was checked to be working in this patch. One notable change: The actual downloading of the kubeadm images was moved to {download,sync)_container, to enable caching.
Note 1: I considered splitting this patch, but most changes that are not directly related to caching, are a pleasant by-product of implementing the caching code, so splitting would be impractical.
Note 2: I have my doubts about the usefulness of the upload, download and upgrade tags in the download role. Must they remain or can they be removed? If anybody knows, then please speak up.
2019-06-10 18:21:07 +00:00
|
|
|
|
|
|
|
- name: set_container_facts | Define by what name to pull the image
|
|
|
|
set_fact:
|
|
|
|
image_reponame: >-
|
|
|
|
{%- if pull_by_digest %}{{ download.repo }}@sha256:{{ download.sha256 }}{%- else -%}{{ download.repo }}:{{ download.tag }}{%- endif -%}
|
|
|
|
|
|
|
|
- name: set_container_facts | Define file name of image
|
|
|
|
set_fact:
|
|
|
|
image_filename: "{{ image_reponame | regex_replace('/|\0|:', '_') }}.tar"
|
|
|
|
|
|
|
|
- name: set_container_facts | Define path of image
|
|
|
|
set_fact:
|
|
|
|
image_path_cached: "{{ download_cache_dir }}/images/{{ image_filename }}"
|
|
|
|
image_path_final: "{{ local_release_dir }}/images/{{ image_filename }}"
|
2020-03-05 15:31:39 +00:00
|
|
|
|
2021-01-18 09:41:44 +00:00
|
|
|
- name: Set image save/load command for docker
|
|
|
|
set_fact:
|
|
|
|
image_save_command: "{{ docker_bin_dir }}/docker save {{ image_reponame }} | gzip -{{ download_compress }} > {{ image_path_final }}"
|
|
|
|
image_load_command: "{{ docker_bin_dir }}/docker load < {{ image_path_final }}"
|
|
|
|
when: container_manager == 'docker'
|
|
|
|
|
2020-12-21 09:54:25 +00:00
|
|
|
- name: Set image save/load command for containerd
|
2020-03-05 15:31:39 +00:00
|
|
|
set_fact:
|
|
|
|
image_save_command: "{{ containerd_bin_dir }}/ctr -n k8s.io image export {{ image_path_final }} {{ image_reponame }}"
|
|
|
|
image_load_command: "{{ containerd_bin_dir }}/ctr -n k8s.io image import --base-name {{ download.repo }} {{ image_path_final }}"
|
2020-12-07 09:09:25 +00:00
|
|
|
when: container_manager == 'containerd'
|
2020-03-05 15:31:39 +00:00
|
|
|
|
2020-12-21 09:54:25 +00:00
|
|
|
- name: Set image save/load command for crio
|
|
|
|
set_fact:
|
|
|
|
image_save_command: "skopeo copy containers-storage:{{ image_reponame }} docker-archive:{{ image_path_final }}"
|
|
|
|
image_load_command: "skopeo copy docker-archive:{{ image_path_final }} containers-storage:{{ image_reponame }}"
|
|
|
|
when: container_manager == 'crio'
|
|
|
|
|
2021-01-18 09:41:44 +00:00
|
|
|
- name: Set image save/load command for docker on localhost
|
|
|
|
set_fact:
|
|
|
|
image_save_command_on_localhost: "{{ docker_bin_dir }}/docker save {{ image_reponame }} | gzip -{{ download_compress }} > {{ image_path_cached }}"
|
|
|
|
when: container_manager_on_localhost == 'docker'
|
|
|
|
|
2020-12-21 09:54:25 +00:00
|
|
|
- name: Set image save/load command for containerd on localhost
|
2020-03-05 15:31:39 +00:00
|
|
|
set_fact:
|
|
|
|
image_save_command_on_localhost: "{{ containerd_bin_dir }}/ctr -n k8s.io image export {{ image_path_cached }} {{ image_reponame }}"
|
2020-12-07 09:09:25 +00:00
|
|
|
when: container_manager_on_localhost == 'containerd'
|
2020-12-21 09:54:25 +00:00
|
|
|
|
|
|
|
- name: Set image save/load command for crio on localhost
|
|
|
|
set_fact:
|
|
|
|
image_save_command_on_localhost: "skopeo copy containers-storage:{{ image_reponame }} docker-archive:{{ image_path_final }}"
|
|
|
|
when: container_manager_on_localhost == 'crio'
|