[docs]defget_deployment_yamls(name:str,namespace:str,image_name:str,container_cmd:str,container_args:str,replicas:int,pull_policy:str,jina_deployment_name:str,pod_type:str,shard_id:Optional[int]=None,port:Optional[int]=None,env:Optional[Dict]=None,gpus:Optional[Union[int,str]]=None,image_name_uses_before:Optional[str]=None,image_name_uses_after:Optional[str]=None,container_cmd_uses_before:Optional[str]=None,container_cmd_uses_after:Optional[str]=None,container_args_uses_before:Optional[str]=None,container_args_uses_after:Optional[str]=None,monitoring:bool=False,port_monitoring:Optional[int]=None,)->List[Dict]:"""Get the yaml description of a service on Kubernetes :param name: name of the service and deployment :param namespace: k8s namespace of the service and deployment :param image_name: image for the k8s deployment :param container_cmd: command executed on the k8s pods :param container_args: arguments used for the k8s pod :param replicas: number of replicas :param pull_policy: pull policy used for fetching the Docker images from the registry. :param jina_deployment_name: Name of the Jina Deployment this deployment belongs to :param pod_type: type os this pod, can be gateway/head/worker :param shard_id: id of this shard, None if shards=1 or this is gateway/head :param port: port which will be exposed by the deployed containers :param env: environment variables to be passed into configmap. :param gpus: number of gpus to use, for k8s requires you pass an int number, refers to the number of requested gpus. :param image_name_uses_before: image for uses_before container in the k8s deployment :param image_name_uses_after: image for uses_after container in the k8s deployment :param container_cmd_uses_before: command executed in the uses_before container on the k8s pods :param container_cmd_uses_after: command executed in the uses_after container on the k8s pods :param container_args_uses_before: arguments used for uses_before container on the k8s pod :param container_args_uses_after: arguments used for uses_after container on the k8s pod :param monitoring: enable monitoring on the deployment :param port_monitoring: port which will be exposed, for the prometheus server, by the deployed containers :return: Return a dictionary with all the yaml configuration needed for a deployment """# we can always assume the ports are the same for all executors since they run on different k8s pods# port expose can be defined by the userifnotport:port=GrpcConnectionPool.K8S_PORTdeployment_params={'name':name,'namespace':namespace,'image':image_name,'replicas':replicas,'command':container_cmd,'args':container_args,'port':port,'port_uses_before':GrpcConnectionPool.K8S_PORT_USES_BEFORE,'port_uses_after':GrpcConnectionPool.K8S_PORT_USES_AFTER,'args_uses_before':container_args_uses_before,'args_uses_after':container_args_uses_after,'command_uses_before':container_cmd_uses_before,'command_uses_after':container_cmd_uses_after,'image_uses_before':image_name_uses_before,'image_uses_after':image_name_uses_after,'pull_policy':pull_policy,'jina_deployment_name':jina_deployment_name,'shard_id':f'\"{shard_id}\"'ifshard_idisnotNoneelse'\"\"','pod_type':pod_type,}ifgpus:deployment_params['device_plugins']={'nvidia.com/gpu':gpus}template_name='deployment'ifimage_name_uses_beforeandimage_name_uses_after:template_name='deployment-uses-before-after'elifimage_name_uses_before:template_name='deployment-uses-before'elifimage_name_uses_after:template_name='deployment-uses-after'ifmonitoring:service_yaml=kubernetes_tools.get_yaml('service_monitoring',{'name':name,'target':name,'namespace':namespace,'port':port,'type':'ClusterIP','port_monitoring':port_monitoring,},)service_monitor_yaml=kubernetes_tools.get_yaml('service_monitor',{'name':name,'target':name,'namespace':namespace,},)else:service_yaml=kubernetes_tools.get_yaml('service',{'name':name,'target':name,'namespace':namespace,'port':port,'type':'ClusterIP',},)service_monitor_yaml=Noneyamls=[kubernetes_tools.get_yaml('configmap',{'name':name,'namespace':namespace,'data':env,},),service_yaml,kubernetes_tools.get_yaml(template_name,deployment_params),]ifservice_monitor_yaml:yamls.append(service_monitor_yaml)returnyamls
[docs]defget_cli_params(arguments:Namespace,skip_list:Tuple[str]=(),port:Optional[int]=None)->str:"""Get cli parameters based on the arguments. :param arguments: arguments where the cli parameters are generated from :param skip_list: list of arguments which should be ignored :param port: overwrite port with the provided value if set :return: string which contains all cli parameters """arguments.host='0.0.0.0'skip_attributes=['uses',# set manually'uses_with',# set manually'runtime_cls',# set manually'workspace','log_config','polling_type','uses_after','uses_before','replicas',]+list(skip_list)ifport:arguments.port=portarg_list=[[attribute,attribute.replace('_','-'),value]forattribute,valueinarguments.__dict__.items()]cli_args=[]forattribute,cli_attribute,valueinarg_list:# TODO: This should not be here, its a workaround for our parser design with boolean valuesifattributeinskip_attributes:continueiftype(value)==boolandvalue:cli_args.append(f'"--{cli_attribute}"')eliftype(value)!=bool:ifvalueisnotNone:value=str(value)value=value.replace('\'','').replace('"','\\"')cli_args.append(f'"--{cli_attribute}", "{value}"')cli_string=', '.join(cli_args)returncli_string
[docs]defdictionary_to_cli_param(dictionary)->str:"""Convert the dictionary into a string to pass it as argument in k8s. :param dictionary: dictionary which has to be passed as argument in k8s. :return: string representation of the dictionary """returnjson.dumps(dictionary).replace('"','\\"')ifdictionaryelse""
