2 # Copyright 2021 Canonical Ltd.
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
16 # For those usages not covered by the Apache License, Version 2.0 please
17 # contact: legal@canonical.com
19 # To get in touch with the maintainers, please contact:
20 # osm-charmers@lists.launchpad.net
23 # pylint: disable=E0213
26 from ipaddress
import ip_network
28 from pathlib
import Path
29 from string
import Template
30 from typing
import NoReturn
, Optional
31 from urllib
.parse
import urlparse
33 from ops
.main
import main
34 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
35 from opslib
.osm
.interfaces
.http
import HttpClient
36 from opslib
.osm
.pod
import (
39 IngressResourceV3Builder
,
42 from opslib
.osm
.validator
import ModelValidator
, validator
45 logger
= logging
.getLogger(__name__
)
48 class ConfigModel(ModelValidator
):
52 site_url
: Optional
[str]
53 cluster_issuer
: Optional
[str]
54 ingress_class
: Optional
[str]
55 ingress_whitelist_source_range
: Optional
[str]
56 tls_secret_name
: Optional
[str]
57 image_pull_policy
: Optional
[str]
60 def validate_port(cls
, v
):
62 raise ValueError("value must be greater than 0")
65 @validator("max_file_size")
66 def validate_max_file_size(cls
, v
):
68 raise ValueError("value must be equal or greater than 0")
71 @validator("site_url")
72 def validate_site_url(cls
, v
):
75 if not parsed
.scheme
.startswith("http"):
76 raise ValueError("value must start with http")
79 @validator("ingress_whitelist_source_range")
80 def validate_ingress_whitelist_source_range(cls
, v
):
85 @validator("image_pull_policy")
86 def validate_image_pull_policy(cls
, v
):
89 "ifnotpresent": "IfNotPresent",
93 if v
not in values
.keys():
94 raise ValueError("value must be always, ifnotpresent or never")
98 class NgUiCharm(CharmedOsmBase
):
99 def __init__(self
, *args
) -> NoReturn
:
100 super().__init
__(*args
, oci_image
="image")
102 self
.nbi_client
= HttpClient(self
, "nbi")
103 self
.framework
.observe(self
.on
["nbi"].relation_changed
, self
.configure_pod
)
104 self
.framework
.observe(self
.on
["nbi"].relation_broken
, self
.configure_pod
)
106 def _check_missing_dependencies(self
, config
: ConfigModel
):
107 missing_relations
= []
109 if self
.nbi_client
.is_missing_data_in_app():
110 missing_relations
.append("nbi")
112 if missing_relations
:
113 raise RelationsMissing(missing_relations
)
115 def _build_files(self
, config
: ConfigModel
):
116 files_builder
= FilesV3Builder()
117 files_builder
.add_file(
119 Template(Path("files/default").read_text()).substitute(
121 server_name
=config
.server_name
,
122 max_file_size
=config
.max_file_size
,
123 nbi_host
=self
.nbi_client
.host
,
124 nbi_port
=self
.nbi_client
.port
,
127 return files_builder
.build()
129 def build_pod_spec(self
, image_info
):
131 config
= ConfigModel(**dict(self
.config
))
133 self
._check
_missing
_dependencies
(config
)
134 # Create Builder for the PodSpec
135 pod_spec_builder
= PodSpecV3Builder()
137 container_builder
= ContainerV3Builder(
138 self
.app
.name
, image_info
, config
.image_pull_policy
140 container_builder
.add_port(name
=self
.app
.name
, port
=config
.port
)
141 container
= container_builder
.build()
142 container_builder
.add_tcpsocket_readiness_probe(
144 initial_delay_seconds
=45,
147 container_builder
.add_tcpsocket_liveness_probe(
149 initial_delay_seconds
=45,
152 container_builder
.add_volume_config(
154 "/etc/nginx/sites-available/",
155 self
._build
_files
(config
),
157 # Add container to pod spec
158 pod_spec_builder
.add_container(container
)
159 # Add ingress resources to pod spec if site url exists
161 parsed
= urlparse(config
.site_url
)
163 "nginx.ingress.kubernetes.io/proxy-body-size": "{}".format(
164 str(config
.max_file_size
) + "m"
165 if config
.max_file_size
> 0
166 else config
.max_file_size
169 if config
.ingress_class
:
170 annotations
["kubernetes.io/ingress.class"] = config
.ingress_class
171 ingress_resource_builder
= IngressResourceV3Builder(
172 f
"{self.app.name}-ingress", annotations
175 if config
.ingress_whitelist_source_range
:
177 "nginx.ingress.kubernetes.io/whitelist-source-range"
178 ] = config
.ingress_whitelist_source_range
180 if config
.cluster_issuer
:
181 annotations
["cert-manager.io/cluster-issuer"] = config
.cluster_issuer
183 if parsed
.scheme
== "https":
184 ingress_resource_builder
.add_tls(
185 [parsed
.hostname
], config
.tls_secret_name
188 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
190 ingress_resource_builder
.add_rule(
191 parsed
.hostname
, self
.app
.name
, config
.port
193 ingress_resource
= ingress_resource_builder
.build()
194 pod_spec_builder
.add_ingress_resource(ingress_resource
)
195 return pod_spec_builder
.build()
198 if __name__
== "__main__":