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 ingress_whitelist_source_range
: Optional
[str]
54 tls_secret_name
: Optional
[str]
57 def validate_port(cls
, v
):
59 raise ValueError("value must be greater than 0")
62 @validator("max_file_size")
63 def validate_max_file_size(cls
, v
):
65 raise ValueError("value must be equal or greater than 0")
68 @validator("site_url")
69 def validate_site_url(cls
, v
):
72 if not parsed
.scheme
.startswith("http"):
73 raise ValueError("value must start with http")
76 @validator("ingress_whitelist_source_range")
77 def validate_ingress_whitelist_source_range(cls
, v
):
83 class NgUiCharm(CharmedOsmBase
):
84 def __init__(self
, *args
) -> NoReturn
:
85 super().__init
__(*args
, oci_image
="image")
87 self
.nbi_client
= HttpClient(self
, "nbi")
88 self
.framework
.observe(self
.on
["nbi"].relation_changed
, self
.configure_pod
)
89 self
.framework
.observe(self
.on
["nbi"].relation_broken
, self
.configure_pod
)
91 def _check_missing_dependencies(self
, config
: ConfigModel
):
92 missing_relations
= []
94 if self
.nbi_client
.is_missing_data_in_app():
95 missing_relations
.append("nbi")
98 raise RelationsMissing(missing_relations
)
100 def _build_files(self
, config
: ConfigModel
):
101 files_builder
= FilesV3Builder()
102 files_builder
.add_file(
104 Template(Path("files/default").read_text()).substitute(
106 server_name
=config
.server_name
,
107 max_file_size
=config
.max_file_size
,
108 nbi_host
=self
.nbi_client
.host
,
109 nbi_port
=self
.nbi_client
.port
,
112 return files_builder
.build()
114 def build_pod_spec(self
, image_info
):
116 config
= ConfigModel(**dict(self
.config
))
118 self
._check
_missing
_dependencies
(config
)
119 # Create Builder for the PodSpec
120 pod_spec_builder
= PodSpecV3Builder()
122 container_builder
= ContainerV3Builder(self
.app
.name
, image_info
)
123 container_builder
.add_port(name
=self
.app
.name
, port
=config
.port
)
124 container
= container_builder
.build()
125 container_builder
.add_tcpsocket_readiness_probe(
127 initial_delay_seconds
=45,
130 container_builder
.add_tcpsocket_liveness_probe(
132 initial_delay_seconds
=45,
135 container_builder
.add_volume_config(
137 "/etc/nginx/sites-available/",
138 self
._build
_files
(config
),
140 # Add container to pod spec
141 pod_spec_builder
.add_container(container
)
142 # Add ingress resources to pod spec if site url exists
144 parsed
= urlparse(config
.site_url
)
146 "nginx.ingress.kubernetes.io/proxy-body-size": "{}".format(
147 str(config
.max_file_size
) + "m"
148 if config
.max_file_size
> 0
149 else config
.max_file_size
152 ingress_resource_builder
= IngressResourceV3Builder(
153 f
"{self.app.name}-ingress", annotations
156 if config
.ingress_whitelist_source_range
:
158 "nginx.ingress.kubernetes.io/whitelist-source-range"
159 ] = config
.ingress_whitelist_source_range
161 if parsed
.scheme
== "https":
162 ingress_resource_builder
.add_tls(
163 [parsed
.hostname
], config
.tls_secret_name
166 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
168 ingress_resource_builder
.add_rule(
169 parsed
.hostname
, self
.app
.name
, config
.port
171 ingress_resource
= ingress_resource_builder
.build()
172 pod_spec_builder
.add_ingress_resource(ingress_resource
)
173 return pod_spec_builder
.build()
176 if __name__
== "__main__":