Search.setIndex({docnames:["_api/airflow/providers/cncf/kubernetes/backcompat/backwards_compat_converters/index","_api/airflow/providers/cncf/kubernetes/backcompat/index","_api/airflow/providers/cncf/kubernetes/backcompat/pod/index","_api/airflow/providers/cncf/kubernetes/backcompat/pod_runtime_info_env/index","_api/airflow/providers/cncf/kubernetes/backcompat/volume/index","_api/airflow/providers/cncf/kubernetes/backcompat/volume_mount/index","_api/airflow/providers/cncf/kubernetes/hooks/index","_api/airflow/providers/cncf/kubernetes/hooks/kubernetes/index","_api/airflow/providers/cncf/kubernetes/index","_api/airflow/providers/cncf/kubernetes/operators/index","_api/airflow/providers/cncf/kubernetes/operators/kubernetes_pod/index","_api/airflow/providers/cncf/kubernetes/operators/spark_kubernetes/index","_api/airflow/providers/cncf/kubernetes/sensors/index","_api/airflow/providers/cncf/kubernetes/sensors/spark_kubernetes/index","connections/kubernetes","index","operators"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/cncf/kubernetes/backcompat/backwards_compat_converters/index.rst","_api/airflow/providers/cncf/kubernetes/backcompat/index.rst","_api/airflow/providers/cncf/kubernetes/backcompat/pod/index.rst","_api/airflow/providers/cncf/kubernetes/backcompat/pod_runtime_info_env/index.rst","_api/airflow/providers/cncf/kubernetes/backcompat/volume/index.rst","_api/airflow/providers/cncf/kubernetes/backcompat/volume_mount/index.rst","_api/airflow/providers/cncf/kubernetes/hooks/index.rst","_api/airflow/providers/cncf/kubernetes/hooks/kubernetes/index.rst","_api/airflow/providers/cncf/kubernetes/index.rst","_api/airflow/providers/cncf/kubernetes/operators/index.rst","_api/airflow/providers/cncf/kubernetes/operators/kubernetes_pod/index.rst","_api/airflow/providers/cncf/kubernetes/operators/spark_kubernetes/index.rst","_api/airflow/providers/cncf/kubernetes/sensors/index.rst","_api/airflow/providers/cncf/kubernetes/sensors/spark_kubernetes/index.rst","connections/kubernetes.rst","index.rst","operators.rst"],objects:{"airflow.providers.cncf":{kubernetes:[8,0,0,"-"]},"airflow.providers.cncf.kubernetes":{backcompat:[1,0,0,"-"],hooks:[6,0,0,"-"],operators:[9,0,0,"-"],sensors:[12,0,0,"-"]},"airflow.providers.cncf.kubernetes.backcompat":{backwards_compat_converters:[0,0,0,"-"],pod:[2,0,0,"-"],pod_runtime_info_env:[3,0,0,"-"],volume:[4,0,0,"-"],volume_mount:[5,0,0,"-"]},"airflow.providers.cncf.kubernetes.backcompat.backwards_compat_converters":{_convert_from_dict:[0,1,1,""],_convert_kube_model_object:[0,1,1,""],convert_affinity:[0,1,1,""],convert_configmap:[0,1,1,""],convert_env_vars:[0,1,1,""],convert_image_pull_secrets:[0,1,1,""],convert_pod_runtime_info_env:[0,1,1,""],convert_port:[0,1,1,""],convert_resources:[0,1,1,""],convert_toleration:[0,1,1,""],convert_volume:[0,1,1,""],convert_volume_mount:[0,1,1,""]},"airflow.providers.cncf.kubernetes.backcompat.pod":{Port:[2,2,1,""],Resources:[2,2,1,""]},"airflow.providers.cncf.kubernetes.backcompat.pod.Port":{__slots__:[2,3,1,""],to_k8s_client_obj:[2,4,1,""]},"airflow.providers.cncf.kubernetes.backcompat.pod.Resources":{__slots__:[2,3,1,""],to_k8s_client_obj:[2,4,1,""]},"airflow.providers.cncf.kubernetes.backcompat.pod_runtime_info_env":{PodRuntimeInfoEnv:[3,2,1,""]},"airflow.providers.cncf.kubernetes.backcompat.pod_runtime_info_env.PodRuntimeInfoEnv":{to_k8s_client_obj:[3,4,1,""]},"airflow.providers.cncf.kubernetes.backcompat.volume":{Volume:[4,2,1,""]},"airflow.providers.cncf.kubernetes.backcompat.volume.Volume":{_convert_to_snake_case:[4,4,1,""],to_k8s_client_obj:[4,4,1,""]},"airflow.providers.cncf.kubernetes.backcompat.volume_mount":{VolumeMount:[5,2,1,""]},"airflow.providers.cncf.kubernetes.backcompat.volume_mount.VolumeMount":{__slots__:[5,3,1,""],to_k8s_client_obj:[5,4,1,""]},"airflow.providers.cncf.kubernetes.hooks":{kubernetes:[7,0,0,"-"]},"airflow.providers.cncf.kubernetes.hooks.kubernetes":{KubernetesHook:[7,2,1,""],_load_body_to_dict:[7,1,1,""]},"airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook":{api_client:[7,4,1,""],conn_name_attr:[7,3,1,""],conn_type:[7,3,1,""],create_custom_object:[7,4,1,""],default_conn_name:[7,3,1,""],get_conn:[7,4,1,""],get_connection_form_widgets:[7,4,1,""],get_custom_object:[7,4,1,""],get_namespace:[7,4,1,""],get_pod_log_stream:[7,4,1,""],get_pod_logs:[7,4,1,""],get_ui_field_behaviour:[7,4,1,""],hook_name:[7,3,1,""]},"airflow.providers.cncf.kubernetes.operators":{kubernetes_pod:[10,0,0,"-"],spark_kubernetes:[11,0,0,"-"]},"airflow.providers.cncf.kubernetes.operators.kubernetes_pod":{KubernetesPodOperator:[10,2,1,""]},"airflow.providers.cncf.kubernetes.operators.kubernetes_pod.KubernetesPodOperator":{_get_pod_identifying_label_string:[10,4,1,""],_set_name:[10,4,1,""],_try_numbers_match:[10,4,1,""],create_labels_for_pod:[10,4,1,""],create_new_pod_for_operator:[10,4,1,""],create_pod_request_obj:[10,4,1,""],execute:[10,4,1,""],handle_pod_overlap:[10,4,1,""],monitor_launched_pod:[10,4,1,""],on_kill:[10,4,1,""],patch_already_checked:[10,4,1,""],template_fields:[10,3,1,""]},"airflow.providers.cncf.kubernetes.operators.spark_kubernetes":{SparkKubernetesOperator:[11,2,1,""]},"airflow.providers.cncf.kubernetes.operators.spark_kubernetes.SparkKubernetesOperator":{execute:[11,4,1,""],template_ext:[11,3,1,""],template_fields:[11,3,1,""],ui_color:[11,3,1,""]},"airflow.providers.cncf.kubernetes.sensors":{spark_kubernetes:[13,0,0,"-"]},"airflow.providers.cncf.kubernetes.sensors.spark_kubernetes":{SparkKubernetesSensor:[13,2,1,""]},"airflow.providers.cncf.kubernetes.sensors.spark_kubernetes.SparkKubernetesSensor":{FAILURE_STATES:[13,3,1,""],SUCCESS_STATES:[13,3,1,""],_log_driver:[13,4,1,""],poke:[13,4,1,""],template_fields:[13,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"1123":10,"120":10,"case":10,"class":[2,3,4,5,7,10,11,13,16],"default":[7,10,16],"final":10,"float":2,"function":10,"import":16,"int":[2,10],"new":10,"public":16,"return":[0,2,3,4,5,7,10,16],"static":[4,7,10],"true":[10,16],"try":10,"var":10,"while":[10,16],DNS:10,For:[7,10,11,13,16],The:[10,14,16],Then:16,There:14,Use:14,Using:16,With:16,__slots__:[2,5],_convert_from_dict:0,_convert_kube_model_object:0,_convert_to_snake_cas:4,_get_pod_identifying_label_str:10,_load_body_to_dict:7,_log_driv:13,_set_nam:10,_try_numbers_match:10,abl:16,about:[7,11,13],abov:7,access:16,account:10,act:16,add:[7,10,16],affin:[0,10,16],airflow:[14,16],all:[10,14,16],allow:16,almost:16,alongsid:16,alpin:16,alreadi:10,also:[10,16],alwai:10,ani:10,annot:10,apach:16,api:[2,3,5,7,10,11,13,15,16],api_cli:7,append:13,appli:10,applic:[11,13],application_fil:11,application_nam:13,application_st:13,arg:16,argument:[10,16],attach:10,attach_log:13,author:[10,16],avail:16,backcompat:8,backward:[2,4,5],backwards_compat_convert:[1,8],bar:16,base:[7,10,11,13],basehook:7,baseoper:[10,11],basesensoroper:13,bash:16,bash_command:16,bashoper:16,behaviour:7,beta:16,blob:[11,13],bodi:7,bool:[10,13],cach:[7,10],can:[10,16],charact:10,check:[7,13],claim_nam:16,client:[3,4,7,10,14,16],client_configur:7,cluster:[7,10,11,13],cluster_context:10,cmd:[10,16],cncf:16,com:[10,11,13],comma:10,command:16,compat:[2,4,5],complet:[10,13],comput:10,concept:10,config:[4,7,10,14,16],config_fil:[10,16],config_map_ref:16,configmap:[0,10],configur:[7,10,16],conn_id:7,conn_name_attr:7,conn_typ:7,connect:[7,11,13,15],consid:[10,16],construct:16,contain:[7,10],container_port:[2,16],context:[10,11,13,16],continu:10,conveni:16,convert:[0,2,3,4,5],convert_affin:0,convert_configmap:0,convert_env_var:0,convert_image_pull_secret:0,convert_pod_runtime_info_env:0,convert_port:0,convert_resourc:0,convert_toler:0,convert_volum:0,convert_volume_mount:0,correct:16,cpu:2,crash:10,crd:7,creat:[7,10,11,16],create_custom_object:7,create_labels_for_pod:10,create_new_pod_for_oper:10,create_pod_request_obj:10,credenti:16,current:10,custom:[7,10,14,16],custom_resource_definit:11,dag:[10,15,16],data:10,default_conn_nam:7,defin:[3,7],definit:[7,16],delet:10,depend:16,deprec:4,detail:[11,13],determin:[10,13],dict:[0,7,10,13],dictionari:0,dies:10,differ:14,disktyp:16,dnspolici:10,do_xcom_push:[10,16],doc:[10,11,13],docker:[10,16],dockerhub:16,document:16,domain:16,driver:13,durat:10,dynam:16,echo:16,ecr:16,either:10,empti:14,enabl:[10,14,16],engin:[10,16],ensur:[10,16],entrypoint:10,env:16,env_from:10,env_var:[0,10],environ:[3,10],ephemer:2,equal:16,equival:16,etc:16,even:16,event:10,exampl:[15,16],example_dag:16,example_kubernet:16,execut:[0,10,11],executor:16,exist:10,expos:10,extra:7,extra__kubernetes__in_clust:7,extra__kubernetes__kube_config:7,extra__kubernetes__kube_config_path:7,f4a460:11,fail:13,failur:[10,16],failure_st:13,fals:[10,13],field:[7,14],field_path:3,file:[7,10,16],filepath:11,find:10,follow:16,foo:16,form:[7,16],format:14,found:10,from:[7,14,16],full_pod_spec:[10,16],fulli:10,further:16,gcr:16,gener:[10,16],get:[7,10],get_conn:7,get_connection_form_widget:7,get_custom_object:7,get_log:[10,16],get_namespac:7,get_pod_log:7,get_pod_log_stream:7,get_ui_field_behaviour:7,github:[11,13],given:10,gkestartpodoper:[10,16],googl:[10,16],googlecloudplatform:[11,13],gpu:2,grace:10,group:[7,10],guid:[10,15],handl:16,handle_pod_overlap:10,have:[11,13,16],hook:8,hook_nam:7,host:[10,16],hostnetwork:10,how:10,http:[11,13,16],hub:10,identifi:10,ifnotpres:10,ignor:10,imag:10,image_pull_polici:10,image_pull_secret:[0,10,16],in_clust:[10,14,16],includ:10,individu:16,inform:[3,7,10,16],init:[10,16],init_contain:[10,16],init_container_volume_mount:16,init_environ:16,initi:10,inject:10,input_str:4,insert:14,insid:14,interact:[2,3,5],interrupt:10,is_delete_operator_pod:[10,16],iter:10,its:10,job:16,json:[10,11,14,16],just:14,k8s:[0,2,3,4,5,10,11,13,16],kei:[10,16],kept:16,key1:16,key2:16,kill:10,kube:[10,14,16],kube_config:14,kubeconfig:[7,16],kubectl:16,kubernetes_conn_id:[7,11,13],kubernetes_default:[7,11,13,14],kubernetes_pod:[8,9],kuberneteshook:7,kubernetespodoper:10,kwarg:[10,11,13],label:[10,16],label_selector:16,languag:16,larg:10,launch:[10,16],launcher:10,leav:14,level:16,like:16,limit:[2,10],limit_cpu:[2,10],limit_ephemeral_storag:2,limit_gpu:[2,10],limit_memori:[2,10],list:[0,10],locat:[14,16],log:[7,10,13],log_events_on_failur:10,look:[10,11,13,16],machin:14,manag:10,mark:14,match:10,match_express:16,matter:16,memori:2,metadata:10,method:16,mkdir:16,model:[3,4,10,11,16],monitor:10,monitor_launched_pod:10,more:[7,10,11,13],mount:[4,5],mount_fil:16,mount_path:[5,16],must:16,name:[2,3,4,5,7,10,13,16],namespac:[7,10,11,13,14,16],nativ:16,need:[10,16],network:10,new_class:0,node_affin:16,node_selector:10,non:10,none:[2,7,10,11,13,16],note:10,noth:10,number:[2,10],obj:0,object:[0,2,3,4,5,7,11,13],occur:[10,16],old_class:0,on_kil:10,onc:[7,10],one:10,onli:10,oper:[8,13,15],optim:16,option:[7,10,11,13,16],orchestr:16,order:[7,16],other:[10,16],otherwis:16,paramet:[0,2,7,10,11,13,16],pass:16,password:16,past:14,patch_already_check:10,path:[7,10,14,16],period:10,permit:10,persistent_volume_claim:16,persistentvolum:10,pleas:4,plu:10,plural:7,pod:[0,1,3,7,8,10,13],pod_affin:16,pod_affinity_term:16,pod_list:10,pod_nam:7,pod_runtime_info_env:[0,1,8,10],pod_task_xcom_result:16,pod_template_fil:[10,16],podlaunch:10,podruntimeinfoenv:[0,3,10],podsecuritycontext:10,podspec:10,point:10,poke:13,polici:10,port:[0,2,10,16],possibl:10,prefer:16,preferred_during_scheduling_ignored_during_execut:16,present:7,previou:10,prioriti:10,priority_class_nam:10,process:[10,16],profil:16,provid:16,publicli:16,pull:[10,16],purpos:10,push:10,put:11,pwd:16,pypi:16,python:[15,16],quai:16,qualifi:10,quay_k8:16,random:10,rang:10,reach:10,read_onli:[5,16],reattach:10,reattach_on_restart:10,recommend:16,refer:[11,13,15],remov:16,repeat:10,repositori:[10,16],repres:16,request:[2,7,10,16],request_cpu:[2,10],request_ephemeral_storag:2,request_memori:[2,10],requir:[10,16],required_during_scheduling_ignored_during_execut:16,resid:[13,14],resourc:[0,2,7,10,13,15,16],respons:13,restart:10,retri:10,retriev:7,root:16,rtype:2,rule:10,run:[10,14,16],runtim:3,safeti:16,same:10,schedul:[10,16],schedulernam:10,second:10,secret:10,secret_a:10,secret_all_kei:16,secret_b:10,secret_env:16,secret_fil:16,secur:[10,16],security_context:10,see:[10,16],self:[2,3,4,5,7,10,11,13],sensor:8,separ:10,server:16,servic:10,service_account_nam:10,session:7,should:[10,13],sidecar:16,simplifi:[10,16],sourc:[0,2,3,4,5,7,10,11,13,16],spark:[11,13],spark_kubernet:[8,9,12],sparkappl:[11,13],sparkkubernetesoper:11,sparkkubernetessensor:13,specifi:[7,10,16],sql_alchemy_conn:16,sql_conn:16,ssd:16,startup:10,startup_timeout_second:10,state:10,stdout:10,still:16,storag:2,str:[0,2,7,10,11,13],stream:7,sub_path:[5,16],subdomain:10,substitut:16,success_st:13,suffix:10,supersed:10,suppli:16,take:[10,14],task:[0,10,16],task_id:16,task_inst:16,templat:[10,16],template_ext:11,template_field:[10,11,13],termin:10,termination_grace_period:10,test:16,testquai:16,than:[10,16],thei:10,thi:[4,7,10],those:16,three:14,through:16,timeout:10,to_k8s_client_obj:[2,3,4,5],toler:[0,10,16],topology_kei:16,track:10,tri:10,try_numbers_match:10,two:16,type:[2,14,15,16],ubuntu:16,ui_color:11,ultim:16,union:7,unknown:13,url:[10,16],usag:2,use:[4,7,10],used:[2,10,14],user:[10,16],usernam:16,uses:16,using:[7,10,14,16],v1affin:[0,10,16],v1beta2:[11,13],v1configmapenvsourc:16,v1contain:[10,16],v1containerport:[0,10,16],v1envfromsourc:[0,10,16],v1envvar:[0,3,10,16],v1labelselector:16,v1labelselectorrequir:16,v1localobjectrefer:[0,10,16],v1nodeaffin:16,v1nodeselectorrequir:16,v1nodeselectorterm:16,v1persistentvolumeclaimvolumesourc:16,v1pod:[10,16],v1podaffin:16,v1podaffinityterm:16,v1preferredschedulingterm:16,v1resourcerequir:[0,10],v1toler:[0,10,16],v1volum:[0,4,10,16],v1volumemount:[0,10,16],v1weightedpodaffinityterm:16,valu:[10,16],value1:16,value2:16,variabl:[3,10,16],version:7,via:[7,16],view:16,volum:[0,1,5,8,10],volume_mount:[0,1,8,10,16],volumemount:[0,5,10],wai:14,weight:16,what:10,when:10,where:[10,13],whether:13,which:[10,16],widget:7,wish:10,within:10,would:16,write:16,write_xcom:16,written:16,xcom:10,xcom_pul:16,yaml:[11,16],yml:11,you:[10,16],your:16,zone:16},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat.backwards_compat_converters</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat.pod</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat.pod_runtime_info_env</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat.volume</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.backcompat.volume_mount</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.hooks.kubernetes</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.operators.kubernetes_pod</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.operators.spark_kubernetes</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.cncf.kubernetes.sensors.spark_kubernetes</span></code>","Kubernetes cluster Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-cncf-kubernetes</span></code>","KubernetesPodOperator"],titleterms:{"default":14,IDs:14,airflow:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15],apach:15,authent:14,backcompat:[0,1,2,3,4,5],backwards_compat_convert:0,between:16,cluster:[14,16],cncf:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15],configmap:16,configur:14,connect:14,contain:16,content:[0,2,3,4,5,7,10,11,13,15],differ:16,doe:16,hook:[6,7],how:16,imag:16,kubernet:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],kubernetes_pod:10,kubernetespodoper:16,modul:[0,2,3,4,5,7,10,11,13],object:16,oper:[9,10,11,16],pod:[2,16],pod_runtime_info_env:3,privat:16,provid:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15],refer:16,registri:16,secret:16,sensor:[12,13],spark_kubernet:[11,13],spec:16,submodul:[1,6,9,12],subpackag:8,thi:16,use:16,volum:[4,16],volume_mount:5,work:16,xcom:16}})