-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
175 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| if TYPE_CHECKING: | ||
| from render import Render | ||
|
|
||
| try: | ||
| from .error import RenderError | ||
| from .formatter import merge_dicts_no_overwrite | ||
| from .validations import valid_fs_path_or_raise | ||
| from .storage_types import ( | ||
| StorageItemResult, | ||
| TmpfsStorage, | ||
| HostPathStorage, | ||
| IxVolumeStorage, | ||
| CifsStorage, | ||
| NfsStorage, | ||
| ) | ||
| except ImportError: | ||
| from error import RenderError | ||
| from formatter import merge_dicts_no_overwrite | ||
| from validations import valid_fs_path_or_raise | ||
| from storage_types import ( | ||
| StorageItemResult, | ||
| TmpfsStorage, | ||
| HostPathStorage, | ||
| IxVolumeStorage, | ||
| CifsStorage, | ||
| NfsStorage, | ||
| ) | ||
|
|
||
|
|
||
| class VolumeMounts: | ||
| def __init__(self, render_instance: "Render"): | ||
| self._render_instance = render_instance | ||
| self._volume_mounts: set[VolumeMount] = set() | ||
|
|
||
| def add_volume_mount(self, mount_path: str, config: dict): | ||
| mount_path = valid_fs_path_or_raise(mount_path) | ||
| if mount_path in [m.mount_path for m in self._volume_mounts]: | ||
| raise RenderError(f"Mount path [{mount_path}] already used for another volume mount") | ||
|
|
||
| volume_mount = VolumeMount(self._render_instance, mount_path, config) | ||
| self._volume_mounts.add(volume_mount) | ||
|
|
||
| def has_mounts(self) -> bool: | ||
| return bool(self._volume_mounts) | ||
|
|
||
| def render(self): | ||
| return [vm.render() for vm in sorted(self._volume_mounts, key=lambda vm: vm.mount_path)] | ||
|
|
||
|
|
||
| class VolumeMount: | ||
| # TODO: create a type for config | ||
| def __init__(self, render_instance: "Render", mount_path: str, config: dict): | ||
| self._render_instance = render_instance | ||
| self.mount_path: str = mount_path | ||
| self.read_only: bool = config.get("read_only", False) | ||
|
|
||
| self.source: str | None = None # tmpfs does not have a source | ||
| self.spec_type: str = "" | ||
|
|
||
| self.spec_config_for_type: dict = {} | ||
|
|
||
| self.volume_mount_spec: dict = {} | ||
|
|
||
| _type_spec_mapping = { | ||
| "host_path": {"class": HostPathStorage, "spec_type": "bind"}, | ||
| "ix_volume": {"class": IxVolumeStorage, "spec_type": "bind"}, | ||
| "tmpfs": {"class": TmpfsStorage, "spec_type": "tmpfs"}, | ||
| "cifs": {"class": CifsStorage, "spec_type": "volume"}, | ||
| "nfs": {"class": NfsStorage, "spec_type": "volume"}, | ||
| # TODO: anonymous/temporary volumes | ||
| } | ||
|
|
||
| vol_type = config.get("type", None) | ||
| if vol_type not in _type_spec_mapping: | ||
| valid_types = ", ".join(_type_spec_mapping.keys()) | ||
| raise RenderError(f"Volume type [{vol_type}] is not valid. Valid options are: [{valid_types}]") | ||
|
|
||
| # Parse the config for the type | ||
| storage_item: StorageItemResult = _type_spec_mapping[vol_type]["class"](self._render_instance, config).render() | ||
|
|
||
| # Set the type in the mount type for the spec | ||
| self.spec_type = _type_spec_mapping[vol_type]["spec_type"] | ||
|
|
||
| # Make sure source is not empty for all but tmpfs | ||
| if self.spec_type != "tmpfs": | ||
| if not storage_item.source: | ||
| raise RenderError(f"Missing source for volume type [{vol_type}]") | ||
|
|
||
| # Fetch the source (path for bind, volume name for volume) | ||
| self.source = storage_item.source | ||
| # Fetch the type specific config for the mount spec | ||
| self.spec_config_for_type = storage_item.mount_spec | ||
|
|
||
| if self.spec_type == "volume": | ||
| assert self.source is not None | ||
| assert storage_item.volume_spec is not None | ||
| self._render_instance.volumes.add_volume(self.source, storage_item.volume_spec) | ||
|
|
||
| def render(self) -> dict: | ||
| result = { | ||
| "type": self.spec_type, | ||
| "target": self.mount_path, | ||
| "read_only": self.read_only, | ||
| } | ||
|
|
||
| if self.source is not None: | ||
| result["source"] = self.source | ||
|
|
||
| if self.spec_config_for_type: | ||
| result = merge_dicts_no_overwrite(result, self.spec_config_for_type) | ||
|
|
||
| return result |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| if TYPE_CHECKING: | ||
| from render import Render | ||
|
|
||
|
|
||
| class Volumes: | ||
| def __init__(self, render_instance: "Render"): | ||
| self._render_instance = render_instance | ||
| self._volumes: dict[str, Volume] = {} | ||
|
|
||
| def add_volume(self, name: str, config: dict): | ||
| # This method can be called many times from the volume mounts | ||
| # Only add the volume if it is not already added, but dont raise an error | ||
| if name in self._volumes: | ||
| return | ||
| self._volumes[name] = Volume(self._render_instance, config) | ||
|
|
||
| def has_volumes(self) -> bool: | ||
| return bool(self._volumes) | ||
|
|
||
| def render(self): | ||
| return {name: v.render() for name, v in sorted(self._volumes.items())} | ||
|
|
||
|
|
||
| class Volume: | ||
| def __init__(self, render_instance: "Render", config: dict): | ||
| self._render_instance = render_instance | ||
| self._config = config | ||
|
|
||
| def render(self): | ||
| return self._config |