kheops/docs/_build/html/searchindex.js

Search.setIndex({docnames:["api/kheops","api/kheops.plugin","api/kheops.plugin.backend","api/kheops.plugin.scope","api/kheops.plugin.strategy","api/modules","docs/app/cli","docs/app/config","docs/app/examples","docs/app/index","docs/app/installation","docs/app/internal","docs/app/usage","docs/guide/ansible/index","docs/guide/best_practices","docs/guide/index","docs/learn/100","docs/learn/101","docs/learn/102","docs/learn/105","docs/learn/index","index","learn/learn101"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["api/kheops.rst","api/kheops.plugin.rst","api/kheops.plugin.backend.rst","api/kheops.plugin.scope.rst","api/kheops.plugin.strategy.rst","api/modules.rst","docs/app/cli.md","docs/app/config.md","docs/app/examples.rst","docs/app/index.rst","docs/app/installation.rst","docs/app/internal.md","docs/app/usage.rst","docs/guide/ansible/index.md","docs/guide/best_practices.md","docs/guide/index.rst","docs/learn/100.rst","docs/learn/101.md","docs/learn/102.md","docs/learn/105.md","docs/learn/index.rst","index.rst","learn/learn101.md"],objects:{"":[[0,0,0,"-","kheops"]],"kheops.app":[[0,1,1,"","GenericInstance"],[0,1,1,"","Kheops"],[0,1,1,"","KheopsNamespace"]],"kheops.app.GenericInstance":[[0,2,1,"","name"],[0,2,1,"","run"]],"kheops.app.Kheops":[[0,3,1,"","lookup2"],[0,3,1,"","parse_conf"]],"kheops.cli":[[0,1,1,"","CmdApp"]],"kheops.cli.CmdApp":[[0,3,1,"","cli"],[0,3,1,"","cli_demo"],[0,3,1,"","cli_gen_doc"],[0,3,1,"","cli_lookup"],[0,3,1,"","cli_schema"],[0,3,1,"","get_args"],[0,3,1,"","get_logger"]],"kheops.controllers":[[0,1,1,"","LoadPlugin"],[0,1,1,"","Query"],[0,1,1,"","QueryProcessor"]],"kheops.controllers.LoadPlugin":[[0,3,1,"","load"]],"kheops.controllers.Query":[[0,2,1,"","key"],[0,2,1,"","scope"]],"kheops.controllers.QueryProcessor":[[0,3,1,"","CHILDREN_INIT"],[0,2,1,"","default_lookup_item"],[0,2,1,"","default_match_rule"],[0,3,1,"","query"]],"kheops.plugin":[[2,0,0,"-","backend"],[1,0,0,"-","common"],[3,0,0,"-","scope"],[4,0,0,"-","strategy"]],"kheops.plugin.backend":[[2,0,0,"-","file"]],"kheops.plugin.backend.file":[[2,1,1,"","Plugin"]],"kheops.plugin.backend.file.Plugin":[[2,2,1,"","extensions"],[2,3,1,"","fetch_data"]],"kheops.plugin.common":[[1,1,1,"","BackendCandidate"],[1,1,1,"","BackendPlugin"],[1,1,1,"","ConfPlugin"],[1,1,1,"","KheopsItemPlugin"],[1,1,1,"","KheopsListPlugin"],[1,1,1,"","KheopsPlugin"],[1,1,1,"","OutPlugin"],[1,1,1,"","ScopeExtLoop"],[1,1,1,"","ScopePlugin"],[1,1,1,"","StrategyPlugin"]],"kheops.plugin.common.BackendPlugin":[[1,3,1,"","fetch_data"],[1,2,1,"","plugin_kind"],[1,2,1,"","schema_prop"]],"kheops.plugin.common.ConfPlugin":[[1,2,1,"","plugin_kind"],[1,3,1,"","process_list"],[1,2,1,"","schema_prop"]],"kheops.plugin.common.KheopsItemPlugin":[[1,2,1,"","plugin_type"],[1,3,1,"","process_item"]],"kheops.plugin.common.KheopsListPlugin":[[1,2,1,"","plugin_type"],[1,3,1,"","process_list"]],"kheops.plugin.common.KheopsPlugin":[[1,2,1,"","plugin_kind"],[1,2,1,"","plugin_name"],[1,2,1,"","plugin_type"]],"kheops.plugin.common.OutPlugin":[[1,2,1,"","plugin_kind"],[1,3,1,"","process_item"],[1,2,1,"","schema_prop"]],"kheops.plugin.common.ScopeExtLoop":[[1,3,1,"","loop_over"],[1,2,1,"","schema_props"]],"kheops.plugin.common.ScopePlugin":[[1,2,1,"","plugin_kind"],[1,3,1,"","process_item"],[1,2,1,"","schema_prop"]],"kheops.plugin.common.StrategyPlugin":[[1,3,1,"","merge_results"],[1,2,1,"","plugin_kind"],[1,2,1,"","schema_prop"]],"kheops.plugin.scope":[[3,0,0,"-","hier"],[3,0,0,"-","loop"]],"kheops.plugin.scope.hier":[[3,1,1,"","Plugin"]],"kheops.plugin.scope.hier.Plugin":[[3,3,1,"","process_items"]],"kheops.plugin.scope.loop":[[3,1,1,"","Plugin"]],"kheops.plugin.scope.loop.Plugin":[[3,3,1,"","process_items"]],"kheops.plugin.strategy":[[4,0,0,"-","last"],[4,0,0,"-","merge_deep"]],"kheops.plugin.strategy.last":[[4,1,1,"","Plugin"]],"kheops.plugin.strategy.last.Plugin":[[4,3,1,"","merge_results"],[4,2,1,"","selector"]],"kheops.plugin.strategy.merge_deep":[[4,1,1,"","Plugin"]],"kheops.plugin.strategy.merge_deep.Plugin":[[4,3,1,"","merge_results"],[4,2,1,"","selector"]],"kheops.utils":[[0,1,1,"","Default"],[0,4,1,"","glob_files"],[0,4,1,"","path_assemble_hier"],[0,4,1,"","render_template"],[0,4,1,"","render_template_python"],[0,4,1,"","schema_validate"],[0,4,1,"","str_ellipsis"]],kheops:[[0,0,0,"-","app"],[0,0,0,"-","cli"],[0,0,0,"-","controllers"],[1,0,0,"-","plugin"],[0,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"0":[0,22],"00m":22,"01":22,"02":22,"0500":22,"094525316":22,"1":22,"10":22,"100":17,"101":[11,20,21],"102":[20,21],"103":18,"104":[15,21],"105":[20,21],"11":22,"12":22,"12h":22,"15":22,"1m":22,"2":[11,17,22],"20":22,"2022":22,"3":22,"31m":22,"3306":22,"34mexampl":22,"34mnode":22,"34mrole":22,"35m":22,"36m":22,"4":16,"42":22,"5":22,"51":22,"53":22,"60":0,"62":22,"63":22,"7":22,"80":22,"999":22,"case":[11,16,22],"catch":16,"class":[0,1,2,3,4,13,14],"default":[0,1,14,16,22],"do":[16,21,22],"export":22,"import":16,"kh\u00e9op":[16,20],"new":[16,21,22],"null":1,"public":22,"return":[0,4,11,16,17,21],"static":13,"switch":22,"throw":16,"true":[0,1,22],"try":[11,17,22],"var":1,"while":[11,22],A:22,And:[14,22],As:22,But:[16,22],For:22,IT:17,If:[16,22],In:16,It:[11,14,16,17,18,22],Not:18,On:22,THe:13,TO:18,That:16,The:[0,11,14,16,21,22],Then:[11,16,17],There:22,These:16,To:[16,22],With:[14,16,18],_out:1,_scope:1,_strategi:1,abl:[0,14,16,22],about:16,accord:[11,17],account:[11,16,17],across:[16,22],act:22,actual:18,ad:16,adapt:16,add:[16,18,22],address:16,advantag:13,again:[16,22],against:[0,16,21],agre:16,aim:16,alias:13,all:[0,11,16,17,22],allow:[1,11,16],along:22,alreadi:[16,22],also:[11,16,17,22],alwai:[11,13,17,22],among:22,an:[11,16,17,21,22],ani:[16,22],anoth:16,ansibl:[11,14,15,17,19,21,22],answer:[16,21],anyconfig:11,anyof:1,anyth:[11,16,17,22],anywher:16,api:[11,16,21],app:[5,21],app_domain_org:22,append:[0,18],appli:[11,13,14,17,18,20,21],applic:[0,16,20,21],appropri:[16,21],ar:[11,13,14,16,17,18,22],area:16,arrai:[1,16,18],asia:16,ask:22,assign:[13,22],attribut:[16,22],auto:22,avoid:16,aweb:22,back:[16,21],backend:[0,1,3,11,17,22],backend_index:22,backendcandid:1,backendplugin:[1,2],base:[0,1,2,3,4,14,16,21],baselin:16,bash:22,basi:[16,21],basic:[20,21],beast:16,becaus:16,becom:[16,22],been:[16,22],befor:[16,22],behind:16,being:16,bell:22,belong:16,best:[14,16],better:22,between:[16,22],bill:16,both:[16,22],bottom:16,bug:18,build:[16,22],built:[16,22],c:22,cach:22,callback:1,callback_context:1,can:[0,11,14,16,17,21,22],candid:[1,4,22],care:16,carefulli:16,cascad:16,cat:22,catalog:14,catchment:16,cd:22,centr:16,certain:[16,21],certainli:[16,21],chang:[14,16,22],check:22,chf:16,children_init:0,china:16,circumst:16,cleanest:16,cli:[5,9,21],cli_demo:0,cli_gen_doc:0,cli_lookup:0,cli_schema:0,clunki:22,cmdapp:0,code:[2,14,16],collect:14,colour:22,com:22,combin:16,come:[16,22],command:[0,20,21],common:[0,2,3,4,5,14,16],compani:16,compar:22,compat:[0,11],complet:[16,22],complex:[11,16,22],complic:16,compos:[13,17],concept:[20,21],condit:[16,21],conf:[1,3,22],config:[0,2,9,21,22],configur:[0,16,21,22],confplugin:1,connect:16,consist:[11,16,22],consul:1,contain:16,content:[11,17],context:16,contin:16,continu:[0,22],control:[5,21],convolut:16,correclti:22,correct:16,cost:16,could:16,countri:16,cover:16,creat:[0,22],create_fil:0,criteria:[16,22],crucial:[16,21],curl:[11,17],currenc:16,custom:16,d:14,data:[0,1,11,16,17,18,21,22],databas:[0,16,22],datastor:16,deal:16,debug:[14,22],debug_us:22,decid:16,declar:16,dedic:14,default_lookup_item:0,default_match_rul:0,defin:[16,20,21],demand:16,demo:22,denomin:16,depend:22,deploi:16,design:13,determin:[11,16,17],dev:22,develop:16,dichotomi:22,dict:[0,4,11,18,22],did:22,diff:22,differ:[11,16,17,21,22],directori:22,displai:0,distinct:16,dn:16,document:[0,9,16],doesn:16,domain:22,domain_org:22,domain_org_extern:22,don:16,down:[16,21],drive:16,dure:14,dynam:[13,14],e:22,each:22,easi:22,easili:14,echo:22,edg:16,eg:16,either:[0,22],element:16,ellipsi:0,els:16,enc:14,end:[16,21],endpoint:16,engin:[11,17],entri:16,env:22,env_:22,env_dev:22,env_prod:22,environ:[16,20,21],environn:14,eof:22,essenc:16,essenti:[11,16,17],eur:16,europ:16,european:16,even:[16,22],eventu:16,everi:16,everyon:16,everyth:16,ex1_enc:22,exampl:[9,11,16,21,22],exit:22,expand:22,expect:22,explain:[0,14,22],express:16,ext:22,extens:[1,2],extrem:16,f:22,face:22,fairli:16,fall:16,fals:[0,22],fd:22,featur:16,fetch_data:[1,2],fictiv:22,file:[0,1,11,17,18,22],filter:[11,17],find:[16,21,22],finish:22,first:[1,11,16,17,22],fix:18,flag:22,flat:[16,21],flexibl:16,focu:22,follow:[16,22],foreman:[14,19],form:22,found:[11,16,17,22],franc:16,fresh:22,from:[16,22],fun:16,further:[16,21],futur:[11,17,18,19],gbp:16,gen_doc:22,gener:[0,2,11,13,16],genericinst:0,germani:16,get:[16,22],get_arg:0,get_logg:0,git:14,give:[16,21],given:[0,16,21,22],glob:[0,1],glob_fil:0,global:[16,21],gnu:[14,22],go:[14,16],goe:[11,17],good:22,got:16,grep:[14,22],group:13,guid:21,h:22,ha:[16,22],had:16,handl:16,hard:22,hashmap:16,have:[16,22],haven:16,he:22,head:22,header:22,help:22,here:[16,21,22],hier:[0,1,11,17],hier_n:1,hiera:[11,17],hierachi:22,hierarch:[11,17,20,21,22],hierarchi:[0,3,14,18,20,21],higher:16,hit:16,home:22,hostgroup:18,hostnam:16,hour:22,how:[0,11,16,17,22],howev:[16,22],http:[1,16],httpd_server:22,i:16,iac:14,ident:16,identifi:[16,22],ignore_miss:0,illustr:22,imagin:16,implement:16,includ:[1,18],increas:22,incred:16,index:[21,22],info:22,infra:22,infrastructur:[20,21],init:1,insid:22,inspect:22,instac:0,instal:[9,21],instanc:[0,16,22],integr:[11,14,16,19],inteligentelli:11,intelligentelli:[11,17],interfac:0,intern:[9,21],introduc:16,introduct:[20,21],inventori:[13,14],involv:16,ip:16,issu:18,item:[1,14,18],item_list:1,iter:22,its:[11,17],itself:16,jerakia:[11,16,17],jez:22,jinja:14,json:[0,11,22],jsonschema:0,just:[14,16,21,22],k:22,kdatabas:22,keep:[11,16,17,22],kei:[0,11,14,16,17,18,21,22],kexampl:22,kheop:[11,14,17,21,22],kheops_config:22,kheops_namespac:22,kheops_verbos:22,kheopsitemplugin:1,kheopslistplugin:1,kheopsnamespac:0,kheopsplugin:1,kind:0,know:16,kprofil:22,kweb_user_list:22,land:16,languag:16,last:[0,1,11,16,17],layer:[16,21],learn:[15,21],lend:16,length:0,less:22,let:[16,22],level:16,librari:1,like:[14,16,22],line:[0,20,21],list:[0,1,2,4,11,17,18,22],ll:16,load:[0,11,22],loadplugin:0,locat:[11,14,16,17,22],log:0,logger:0,logger_nam:0,logic:16,look:[11,16,17,21,22],lookup2:0,lookup:[0,1,3,11,14,17,20,21,22],loop:[0,1,11,17,18],loop_n:1,loop_ov:1,lot:16,lowest:16,m:22,machin:16,mai:[16,22],main:[0,16],make:[0,16],manag:[20,21],manual:22,map:16,match:[0,4,11,17],mean:16,meet:16,mention:22,merg:[1,11,17,18,22],merge_deep:[0,1],merge_result:[1,4],messag:22,metadata:22,method:[0,16,22],might:16,mind:[16,22],mission:13,mix:16,mkdir:22,mode:14,model:[14,16],modifi:[11,17],modul:[5,21],modular:[11,17],more:[11,16],most:16,move:[14,16],much:16,multipl:[16,21,22],must:[11,16],my:[14,16],myapp:22,mysql:22,mysql_:22,mysql_clust:22,mysql_databas:22,mysql_port:22,mysql_serv:22,mysql_us:22,n:22,name:[0,14,22],namespac:[0,1,2,3,4],navig:22,need:[16,22],net:22,network:16,next:[16,21],nice:22,no_app:22,no_databas:22,no_env:22,no_product:22,node:[20,21],none:[0,1],normal:16,note:16,noth:[16,21],now:[16,22],number:16,object:[0,1],off:16,ok:16,one:16,onli:16,option:[1,22],org:22,organis:22,origin:16,other:[16,18],our:[16,22],out:[1,16],outplugin:1,output:22,over:[1,16,22],overrid:[16,20,21],overridden:16,overview:[16,22],p:22,packag:[5,21],page:21,pair:[16,21],param:0,paramet:[0,16,22],pars:0,parse_conf:0,part:[11,16,17],partial:16,particular:[16,21],path:[0,1,11,16,22],path_assemble_hi:0,pattern:[0,13,14,16],per:[20,21],perform:[16,18,21],person:22,place:[16,21,22],placehold:[14,22],playbook:13,pluggabl:16,plugin:[0,5,11,13,17],plugin_kind:1,plugin_nam:1,plugin_typ:1,point:[16,22],polici:0,port:16,possibl:[14,16],post:16,potenti:16,power:13,practic:14,prepar:0,pretti:16,previou:0,previous:[11,17],principl:16,prj:22,problem:16,procedur:[9,21],process:11,process_item:[1,3],process_list:1,prod:22,product:[14,16,22],profil:[13,14,22],program:16,properti:1,provid:[0,16],puppet:[14,19],put:[14,22],pwd:22,python:21,queri:[0,4,11,16,17,18,21,22],queryprocessor:0,quit:[11,14,16,22],r:[14,22],radic:14,rather:[16,21],raw_path:22,re:16,read:22,reduc:22,refer:16,regardless:16,rel_path:22,relat:[16,22],rememb:16,render:0,render_templ:0,render_template_python:0,replac:[11,14,17,18],repres:16,request:[16,21,22],requestor:16,requir:22,resolut:[16,21],resolv:[11,16],resourc:[14,20],respect:16,respond:16,rest:[11,16],result:[4,11,16,17,18,21,22],revers:0,rf:22,right:16,rm:22,role:[13,14,20,21],rout:16,rule:[1,4,11,17],run:[0,1],runtim:[0,14,22],rw:14,s:[14,16,22],sai:[16,21,22],same:[16,22],sb:14,scene:16,schema:[0,1,11,14,17,18,22],schema_prop:1,schema_valid:0,scheme:14,scope:[0,1,16,18,22],scopeextloop:[1,3],scopeplugin:[1,3],search:[16,21,22],second:16,see:[11,14,22],select:22,selector:4,sep:0,separ:16,sequenti:[11,17],seri:16,server:[16,19,22],set:[16,22],ship:16,shorthand:13,show:22,simpl:[11,13,16,22],simplem:17,simplest:22,simpli:16,simplifi:16,sinc:16,site:[14,16],small:22,smart:1,snowflak:16,so:[11,16,22],solv:16,some:[14,16,22],someth:16,sometim:22,somewher:16,somwaht:22,sot:11,sourc:[16,21],spain:16,speak:16,special:[16,21],specif:[13,16],specifi:16,sql:16,standalon:16,start:[16,22],start_index:0,statu:[1,14,22],still:16,stop:16,store:[16,22],str:0,str_ellipsi:0,strategi:[0,1,11,17,18],strategyplugin:[1,4],strict:14,string:[0,1,11],strip:16,structur:[14,16],strucutr:[11,17],stuff:16,sub:18,subcommand2:22,subcommand:22,submodul:[5,21],subpackag:[5,21],support:[11,22],surpris:22,switzerland:16,sysadmin:22,system:16,t:16,tail:22,take:[11,13,17],taken:16,talk:16,target:11,tax:16,team:22,techin:11,tell:16,templat:0,tend:16,text:0,than:[16,21],thats:16,thei:16,them:[11,14,16,17,21,22],thi:[1,11,13,14,17,20,21,22],thing:[14,16],think:16,those:[16,22],though:16,three:16,through:16,tier:16,tiger:22,time:22,tip:22,tofix:11,togeth:16,toml:[1,11],ton:16,too:0,tool:[14,16,20,21],top:[16,22],topic:13,trace:[0,14],track:14,train:22,transact:16,transcend:[16,21],transpar:16,tree:[11,13,14,17,18,22],trick:22,trigger:16,troubleshoot:[20,21],truncat:0,two:[16,22],txt:0,type:[0,1,11,16,18,22],typic:16,u:22,uk:16,unconfigur:22,under:[16,21],underli:16,understand:14,unifi:16,uniqu:22,until:[16,21],up:[16,21],url:[11,17],us:[0,11,13,14,16,18,21,22],usag:[9,21,22],usd:16,useful:22,user:[16,22],usual:[11,14,17],util:[5,21,22],v:22,val1:22,val2:22,valid:[0,1,11,22],validate_schema:0,valu:[11,16,17,21,22],var1:22,var2:22,var_nam:1,variabil:22,variabl:[0,14,18,22],vault:1,ve:16,verbos:[0,22],veri:16,view:22,volum:22,vs:14,wa:16,wai:[14,16,21],want:[13,16,22],we:[13,16,21,22],web:[19,22],web_app:22,web_cach:22,web_port:22,web_top_domain:22,web_user_list:22,webserv:22,welcom:21,well:16,what:[11,16,17,18],whatev:[11,17],when:[16,21],whenev:16,where:[16,22],which:[11,16,21,22],whichev:16,whole:16,wide:0,widest:16,win:16,within:16,without:18,word:22,work:[11,14,17,22],world:16,worldwid:16,would:[16,22],wouldn:16,wrong:22,x:22,xarg:22,y:14,yaml:[2,11,22],yaml_scope_fil:22,yml:[0,2,22],you:[11,14,16,22],your:[14,16,22],yourself:16},titles:["kheops package","kheops.plugin package","kheops.plugin.backend package","kheops.plugin.scope package","kheops.plugin.strategy package","kheops","CLI","Config","Examples \u2026","Application","Instalation procedure","Internals","usage !!!","Ansible","Learn 104","Guides","Introduction","Learn 101","Learn 102","Learn 105","Learn","Kh\u00e9ops documentation","Kh\u00e9ops 101"],titleterms:{"101":[17,22],"102":18,"104":14,"105":19,"kh\u00e9op":[21,22],A:16,ansibl:13,app:0,appli:16,applic:[9,22],backend:2,basic:22,cli:[0,6],command:22,common:1,concept:16,config:7,content:[8,9,16,20,21],control:0,defin:22,document:21,environ:22,exampl:8,file:2,guid:15,hier:3,hierarch:16,hierarchi:[16,22],indic:21,infrastructur:16,instal:10,intern:11,introduct:16,kheop:[0,1,2,3,4,5],last:4,learn:[14,17,18,19,20],line:22,lookup:16,loop:3,manag:16,merge_deep:4,modul:[0,1,2,3,4],node:22,overrid:22,packag:[0,1,2,3,4],per:22,plugin:[1,2,3,4],procedur:10,role:22,scope:3,strategi:4,submodul:[0,1,2,3,4],subpackag:[0,1],tabl:[8,16,21],thi:16,tool:22,troubleshoot:22,usag:12,util:0}})