forked from gnuoy/snap-openstack
-
Notifications
You must be signed in to change notification settings - Fork 35
feat: generate zadara charm #775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ahmad-can
wants to merge
3
commits into
canonical:main
Choose a base branch
from
ahmad-can:feature/generate-zadara-charm
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,4 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """Zadara backend for Sunbeam storage.""" |
124 changes: 124 additions & 0 deletions
124
sunbeam-python/sunbeam/storage/backends/zadara/backend.py
This file contains hidden or 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,124 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """ZadaraVPSA iSCSI backend implementation using base step classes.""" | ||
|
|
||
| import logging | ||
| from enum import StrEnum | ||
| from typing import Annotated | ||
|
|
||
| from pydantic import Field | ||
| from rich.console import Console | ||
|
|
||
| from sunbeam.core.manifest import StorageBackendConfig | ||
| from sunbeam.storage.base import StorageBackendBase | ||
| from sunbeam.storage.models import SecretDictField | ||
|
|
||
| LOG = logging.getLogger(__name__) | ||
| console = Console() | ||
|
|
||
|
|
||
| class Protocol(StrEnum): | ||
| """Enumeration of valid protocol types.""" | ||
|
|
||
| ISCSI = "iscsi" | ||
|
|
||
|
|
||
| class ZadaraConfig(StorageBackendConfig): | ||
| """Configuration model for ZadaraVPSA iSCSI backend. | ||
|
|
||
| This model includes ALL configuration options for the backend. | ||
| Additional configuration can be managed dynamically through the charm. | ||
| """ | ||
|
|
||
| # Mandatory connection parameters | ||
| san_ip: Annotated[ | ||
| str, Field(description="Storage array management IP address or hostname.") | ||
| ] | ||
| protocol: Annotated[ | ||
| Protocol | None, | ||
| Field(description="Protocol selector: iscsi."), | ||
| ] = None | ||
| zadara_access_key: Annotated[ | ||
| str, | ||
| Field(description="VPSA access key"), | ||
| SecretDictField(field="zadara-access-key"), | ||
| ] | ||
|
|
||
| # Optional backend configuration | ||
| zadara_vpsa_host: Annotated[ | ||
| str | None, Field(description="VPSA - Management Host name or IP address") | ||
| ] = None | ||
| zadara_vpsa_port: Annotated[int | None, Field(description="VPSA - Port number")] = ( | ||
| None | ||
| ) | ||
| zadara_vpsa_use_ssl: Annotated[ | ||
| bool | None, Field(description="VPSA - Use SSL connection") | ||
| ] = None | ||
| zadara_ssl_cert_verify: Annotated[ | ||
| bool | None, | ||
| Field( | ||
| description=( | ||
| "If set to True the http client will validate" | ||
| " the SSL certificate of the VPSA endpoint." | ||
| ) | ||
| ), | ||
| ] = None | ||
| zadara_vpsa_poolname: Annotated[ | ||
| str | None, Field(description="VPSA - Storage Pool assigned for volumes") | ||
| ] = None | ||
| zadara_vol_encrypt: Annotated[ | ||
| bool | None, Field(description="VPSA - Default encryption policy for volumes.") | ||
| ] = None | ||
| zadara_gen3_vol_dedupe: Annotated[ | ||
| bool | None, Field(description="VPSA - Enable deduplication for volumes.") | ||
| ] = None | ||
| zadara_gen3_vol_compress: Annotated[ | ||
| bool | None, Field(description="VPSA - Enable compression for volumes.") | ||
| ] = None | ||
| zadara_default_snap_policy: Annotated[ | ||
| bool | None, Field(description="VPSA - Attach snapshot policy for volumes.") | ||
| ] = None | ||
| zadara_use_iser: Annotated[ | ||
| bool | None, Field(description="VPSA - Use ISER instead of iSCSI") | ||
| ] = None | ||
| zadara_vol_name_template: Annotated[ | ||
| str | None, Field(description="VPSA - Default template for VPSA volume names") | ||
| ] = None | ||
|
|
||
|
|
||
| class ZadaraBackend(StorageBackendBase): | ||
| """ZadaraVPSA iSCSI backend implementation.""" | ||
|
|
||
| backend_type = "zadara" | ||
| display_name = "ZadaraVPSA iSCSI" | ||
| generally_available = True | ||
|
|
||
| @property | ||
| def charm_name(self) -> str: | ||
| """Return the charm application name.""" | ||
| return "cinder-volume-zadara" | ||
|
|
||
| @property | ||
| def charm_channel(self) -> str: | ||
| """Return the default charm channel.""" | ||
| return "latest/edge" | ||
|
|
||
| @property | ||
| def charm_revision(self) -> str | None: | ||
| """Return a pinned charm revision, if any.""" | ||
| return None | ||
|
|
||
| @property | ||
| def charm_base(self) -> str: | ||
| """Return the target base for this charm.""" | ||
| return "ubuntu@24.04" | ||
|
|
||
| @property | ||
| def supports_ha(self) -> bool: | ||
| """Whether this backend supports HA deployments.""" | ||
| return False | ||
|
|
||
| def config_type(self) -> type[StorageBackendConfig]: | ||
| """Return the configuration model type for this backend.""" | ||
| return ZadaraConfig | ||
This file contains hidden or 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 hidden or 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
70 changes: 70 additions & 0 deletions
70
sunbeam-python/tests/unit/sunbeam/storage/backends/test_zadara.py
This file contains hidden or 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,70 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """Tests for Zadara backend.""" | ||
|
|
||
| import pytest | ||
| from pydantic import ValidationError | ||
|
|
||
| from sunbeam.storage.models import SecretDictField | ||
| from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests | ||
|
|
||
|
|
||
| class TestZadaraBackend(BaseBackendTests): | ||
| """Tests for Zadara backend.""" | ||
|
|
||
| @pytest.fixture | ||
| def backend(self, zadara_backend): | ||
| """Provide Zadara backend instance.""" | ||
| return zadara_backend | ||
|
|
||
| def test_backend_type_is_zadara(self, backend): | ||
| """Test that backend type is 'zadara'.""" | ||
| assert backend.backend_type == "zadara" | ||
|
|
||
| def test_charm_name_is_zadara_charm(self, backend): | ||
| """Test that charm name is cinder-volume-zadara.""" | ||
| assert backend.charm_name == "cinder-volume-zadara" | ||
|
|
||
| def test_config_has_expected_fields(self, backend): | ||
| """Test that Zadara config exposes the expected fields.""" | ||
| fields = backend.config_type().model_fields | ||
| for field in ("san_ip", "protocol", "zadara_access_key"): | ||
| assert field in fields, f"Expected field {field} not found in config" | ||
|
|
||
| def test_sensitive_fields_are_marked_secret(self, backend): | ||
| """Test that access key field is marked as secret.""" | ||
| config_class = backend.config_type() | ||
| field = config_class.model_fields.get("zadara_access_key") | ||
| assert field is not None | ||
| assert any(isinstance(m, SecretDictField) for m in field.metadata), ( | ||
| "zadara_access_key should be marked as secret" | ||
| ) | ||
|
|
||
|
|
||
| class TestZadaraConfigValidation: | ||
| """Test Zadara config validation behavior.""" | ||
|
|
||
| def test_protocol_rejects_invalid_value(self, zadara_backend): | ||
| """Test that protocol rejects values other than iscsi.""" | ||
| config_class = zadara_backend.config_type() | ||
| with pytest.raises(ValidationError): | ||
| config_class.model_validate( | ||
| { | ||
| "san-ip": "192.168.1.1", | ||
| "zadara-access-key": "secret", | ||
| "protocol": "fc", | ||
| } | ||
| ) | ||
|
|
||
| def test_protocol_accepts_iscsi(self, zadara_backend): | ||
| """Test that protocol accepts iscsi.""" | ||
| config_class = zadara_backend.config_type() | ||
| config = config_class.model_validate( | ||
| { | ||
| "san-ip": "192.168.1.1", | ||
| "zadara-access-key": "secret", | ||
| "protocol": "iscsi", | ||
| } | ||
| ) | ||
| assert config.protocol == "iscsi" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.