index.html 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../webhook/">
  7. <link rel="next" href="../uuid/">
  8. <link rel="icon" href="../../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.13">
  10. <title>Github - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../../assets/stylesheets/main.342714a4.min.css">
  12. <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#github-app-authentication-documentation" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Github
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  85. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item md-tabs__item--active">
  127. <a href="../../components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../../introduction/glossary/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Glossary
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../../introduction/prerequisites/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Prerequisites
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../../introduction/getting-started/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Getting started
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../../introduction/faq/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. FAQ
  227. </span>
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../../introduction/stability-support/" class="md-nav__link">
  232. <span class="md-ellipsis">
  233. Stability and Support
  234. </span>
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../../../introduction/deprecation-policy/" class="md-nav__link">
  239. <span class="md-ellipsis">
  240. Deprecation Policy
  241. </span>
  242. </a>
  243. </li>
  244. </ul>
  245. </nav>
  246. </li>
  247. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  248. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  250. <span class="md-ellipsis">
  251. API
  252. </span>
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  256. <label class="md-nav__title" for="__nav_2">
  257. <span class="md-nav__icon md-icon"></span>
  258. API
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../../components/" class="md-nav__link">
  263. <span class="md-ellipsis">
  264. Components
  265. </span>
  266. </a>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  270. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  271. <span class="md-ellipsis">
  272. Core Resources
  273. </span>
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  277. <label class="md-nav__title" for="__nav_2_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Core Resources
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item">
  283. <a href="../../externalsecret/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ExternalSecret
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../secretstore/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. SecretStore
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../clustersecretstore/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. ClusterSecretStore
  300. </span>
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="../../clusterexternalsecret/" class="md-nav__link">
  305. <span class="md-ellipsis">
  306. ClusterExternalSecret
  307. </span>
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="../../clusterpushsecret/" class="md-nav__link">
  312. <span class="md-ellipsis">
  313. ClusterPushSecret
  314. </span>
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../../pushsecret/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. PushSecret
  321. </span>
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" checked>
  329. <div class="md-nav__link md-nav__container">
  330. <a href="../" class="md-nav__link ">
  331. <span class="md-ellipsis">
  332. Generators
  333. </span>
  334. </a>
  335. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. </div>
  339. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="true">
  340. <label class="md-nav__title" for="__nav_2_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Generators
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../acr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Azure Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../ecr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. AWS Elastic Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../sts/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. AWS STS Session Token
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../cluster/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Cluster Generator
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../gcr/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Google Container Registry
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../quay/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Quay
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../vault/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Vault Dynamic Secret
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../password/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Password
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../fake/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Fake
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../webhook/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Webhook
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item md-nav__item--active">
  416. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  417. <label class="md-nav__link md-nav__link--active" for="__toc">
  418. <span class="md-ellipsis">
  419. Github
  420. </span>
  421. <span class="md-nav__icon md-icon"></span>
  422. </label>
  423. <a href="./" class="md-nav__link md-nav__link--active">
  424. <span class="md-ellipsis">
  425. Github
  426. </span>
  427. </a>
  428. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  429. <label class="md-nav__title" for="__toc">
  430. <span class="md-nav__icon md-icon"></span>
  431. Table of contents
  432. </label>
  433. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="#github-app-authentication-documentation" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. GitHub App Authentication Documentation
  438. </span>
  439. </a>
  440. <nav class="md-nav" aria-label="GitHub App Authentication Documentation">
  441. <ul class="md-nav__list">
  442. <li class="md-nav__item">
  443. <a href="#1-register-a-github-app" class="md-nav__link">
  444. <span class="md-ellipsis">
  445. 1. Register a GitHub App
  446. </span>
  447. </a>
  448. </li>
  449. <li class="md-nav__item">
  450. <a href="#2-store-the-private-key" class="md-nav__link">
  451. <span class="md-ellipsis">
  452. 2. Store the Private Key
  453. </span>
  454. </a>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="#3-set-permissions-for-the-github-app" class="md-nav__link">
  458. <span class="md-ellipsis">
  459. 3. Set Permissions for the GitHub App
  460. </span>
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="#4-install-your-github-app" class="md-nav__link">
  465. <span class="md-ellipsis">
  466. 4. Install Your GitHub App
  467. </span>
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="#5-obtain-an-installation-id" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. 5. Obtain an Installation ID
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="#example-kubernetes-manifest-for-github-access-token-generator" class="md-nav__link">
  479. <span class="md-ellipsis">
  480. Example Kubernetes Manifest for GitHub Access Token Generator
  481. </span>
  482. </a>
  483. </li>
  484. <li class="md-nav__item">
  485. <a href="#notes" class="md-nav__link">
  486. <span class="md-ellipsis">
  487. Notes
  488. </span>
  489. </a>
  490. </li>
  491. </ul>
  492. </nav>
  493. </li>
  494. </ul>
  495. </nav>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../uuid/" class="md-nav__link">
  499. <span class="md-ellipsis">
  500. UUID
  501. </span>
  502. </a>
  503. </li>
  504. </ul>
  505. </nav>
  506. </li>
  507. <li class="md-nav__item md-nav__item--nested">
  508. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  509. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  510. <span class="md-ellipsis">
  511. Reference Docs
  512. </span>
  513. <span class="md-nav__icon md-icon"></span>
  514. </label>
  515. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  516. <label class="md-nav__title" for="__nav_2_4">
  517. <span class="md-nav__icon md-icon"></span>
  518. Reference Docs
  519. </label>
  520. <ul class="md-nav__list" data-md-scrollfix>
  521. <li class="md-nav__item">
  522. <a href="../../spec/" class="md-nav__link">
  523. <span class="md-ellipsis">
  524. API specification
  525. </span>
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../controller-options/" class="md-nav__link">
  530. <span class="md-ellipsis">
  531. Controller Options
  532. </span>
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../metrics/" class="md-nav__link">
  537. <span class="md-ellipsis">
  538. Metrics
  539. </span>
  540. </a>
  541. </li>
  542. </ul>
  543. </nav>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item md-nav__item--nested">
  549. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  550. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  551. <span class="md-ellipsis">
  552. Guides
  553. </span>
  554. <span class="md-nav__icon md-icon"></span>
  555. </label>
  556. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  557. <label class="md-nav__title" for="__nav_3">
  558. <span class="md-nav__icon md-icon"></span>
  559. Guides
  560. </label>
  561. <ul class="md-nav__list" data-md-scrollfix>
  562. <li class="md-nav__item">
  563. <a href="../../../guides/introduction/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Introduction
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item md-nav__item--nested">
  570. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  571. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  572. <span class="md-ellipsis">
  573. External Secrets
  574. </span>
  575. <span class="md-nav__icon md-icon"></span>
  576. </label>
  577. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  578. <label class="md-nav__title" for="__nav_3_2">
  579. <span class="md-nav__icon md-icon"></span>
  580. External Secrets
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item">
  584. <a href="../../../guides/all-keys-one-secret/" class="md-nav__link">
  585. <span class="md-ellipsis">
  586. Extract structured data
  587. </span>
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../../guides/getallsecrets/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Find Secrets by Name or Metadata
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../../guides/datafrom-rewrite/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Rewriting Keys
  601. </span>
  602. </a>
  603. </li>
  604. <li class="md-nav__item md-nav__item--nested">
  605. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  606. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  607. <span class="md-ellipsis">
  608. Advanced Templating
  609. </span>
  610. <span class="md-nav__icon md-icon"></span>
  611. </label>
  612. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  613. <label class="md-nav__title" for="__nav_3_2_4">
  614. <span class="md-nav__icon md-icon"></span>
  615. Advanced Templating
  616. </label>
  617. <ul class="md-nav__list" data-md-scrollfix>
  618. <li class="md-nav__item">
  619. <a href="../../../guides/templating/" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. v2
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../../guides/templating-v1/" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. v1
  629. </span>
  630. </a>
  631. </li>
  632. </ul>
  633. </nav>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../../guides/common-k8s-secret-types/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Kubernetes Secret Types
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../../guides/ownership-deletion-policy/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Lifecycle: ownership & deletion
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../../../guides/decoding-strategy/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Decoding Strategies
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../../guides/controller-class/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Controller Classes
  660. </span>
  661. </a>
  662. </li>
  663. </ul>
  664. </nav>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../../../guides/generator/" class="md-nav__link">
  668. <span class="md-ellipsis">
  669. Generators
  670. </span>
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../../guides/pushsecrets/" class="md-nav__link">
  675. <span class="md-ellipsis">
  676. Push Secrets
  677. </span>
  678. </a>
  679. </li>
  680. <li class="md-nav__item md-nav__item--nested">
  681. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  682. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  683. <span class="md-ellipsis">
  684. Operations
  685. </span>
  686. <span class="md-nav__icon md-icon"></span>
  687. </label>
  688. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  689. <label class="md-nav__title" for="__nav_3_5">
  690. <span class="md-nav__icon md-icon"></span>
  691. Operations
  692. </label>
  693. <ul class="md-nav__list" data-md-scrollfix>
  694. <li class="md-nav__item">
  695. <a href="../../../guides/multi-tenancy/" class="md-nav__link">
  696. <span class="md-ellipsis">
  697. Multi Tenancy
  698. </span>
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../../../guides/security-best-practices/" class="md-nav__link">
  703. <span class="md-ellipsis">
  704. Security Best Practices
  705. </span>
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="../../../guides/threat-model/" class="md-nav__link">
  710. <span class="md-ellipsis">
  711. Threat Model
  712. </span>
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="../../../guides/v1beta1/" class="md-nav__link">
  717. <span class="md-ellipsis">
  718. Upgrading to v1beta1
  719. </span>
  720. </a>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="../../../guides/using-latest-image/" class="md-nav__link">
  724. <span class="md-ellipsis">
  725. Using Latest Image
  726. </span>
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="../../../guides/disable-cluster-features/" class="md-nav__link">
  731. <span class="md-ellipsis">
  732. Disable Cluster Features
  733. </span>
  734. </a>
  735. </li>
  736. </ul>
  737. </nav>
  738. </li>
  739. <li class="md-nav__item md-nav__item--nested">
  740. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  741. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  742. <span class="md-ellipsis">
  743. Tooling
  744. </span>
  745. <span class="md-nav__icon md-icon"></span>
  746. </label>
  747. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  748. <label class="md-nav__title" for="__nav_3_6">
  749. <span class="md-nav__icon md-icon"></span>
  750. Tooling
  751. </label>
  752. <ul class="md-nav__list" data-md-scrollfix>
  753. <li class="md-nav__item">
  754. <a href="../../../guides/using-esoctl-tool/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Using the esoctl tool
  757. </span>
  758. </a>
  759. </li>
  760. </ul>
  761. </nav>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. <li class="md-nav__item md-nav__item--nested">
  767. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  768. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  769. <span class="md-ellipsis">
  770. Provider
  771. </span>
  772. <span class="md-nav__icon md-icon"></span>
  773. </label>
  774. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  775. <label class="md-nav__title" for="__nav_4">
  776. <span class="md-nav__icon md-icon"></span>
  777. Provider
  778. </label>
  779. <ul class="md-nav__list" data-md-scrollfix>
  780. <li class="md-nav__item">
  781. <a href="../../../provider/aws-secrets-manager/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. AWS Secrets Manager
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../../provider/aws-parameter-store/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. AWS Parameter Store
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../../provider/azure-key-vault/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Azure Key Vault
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../../provider/beyondtrust/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. BeyondTrust
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Bitwarden Secrets Manager
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../../provider/chef/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Chef
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../../provider/cloudru/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Cloud.ru Secret Manager
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../../provider/conjur/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. CyberArk Conjur
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../../provider/device42/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Device42
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../../provider/google-secrets-manager/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. Google Cloud Secret Manager
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../../provider/hashicorp-vault/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. HashiCorp Vault
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../../provider/kubernetes/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Kubernetes
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../../provider/ibm-secrets-manager/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. IBM Secrets Manager
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../../provider/akeyless/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Akeyless
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../../provider/yandex-certificate-manager/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Yandex Certificate Manager
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../../provider/yandex-lockbox/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Yandex Lockbox
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../../provider/alibaba/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Alibaba Cloud
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../../provider/gitlab-variables/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. GitLab Variables
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../../provider/github/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Github Actions Secrets
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../../provider/oracle-vault/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Oracle Vault
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../../provider/1password-automation/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. 1Password Connect Server
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../../../provider/1password-sdk/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. 1Password SDK
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../../provider/webhook/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Webhook
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="../../../provider/fake/" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. Fake
  945. </span>
  946. </a>
  947. </li>
  948. <li class="md-nav__item">
  949. <a href="../../../provider/senhasegura-dsm/" class="md-nav__link">
  950. <span class="md-ellipsis">
  951. senhasegura DevOps Secrets Management (DSM)
  952. </span>
  953. </a>
  954. </li>
  955. <li class="md-nav__item">
  956. <a href="../../../provider/doppler/" class="md-nav__link">
  957. <span class="md-ellipsis">
  958. Doppler
  959. </span>
  960. </a>
  961. </li>
  962. <li class="md-nav__item">
  963. <a href="../../../provider/keeper-security/" class="md-nav__link">
  964. <span class="md-ellipsis">
  965. Keeper Security
  966. </span>
  967. </a>
  968. </li>
  969. <li class="md-nav__item">
  970. <a href="../../../provider/cloak/" class="md-nav__link">
  971. <span class="md-ellipsis">
  972. Cloak End 2 End Encrypted Secrets
  973. </span>
  974. </a>
  975. </li>
  976. <li class="md-nav__item">
  977. <a href="../../../provider/scaleway/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Scaleway
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../../provider/delinea/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Delinea
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../../provider/secretserver/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Secret Server
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../../provider/passbolt/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Passbolt
  1001. </span>
  1002. </a>
  1003. </li>
  1004. <li class="md-nav__item">
  1005. <a href="../../../provider/pulumi/" class="md-nav__link">
  1006. <span class="md-ellipsis">
  1007. Pulumi ESC
  1008. </span>
  1009. </a>
  1010. </li>
  1011. <li class="md-nav__item">
  1012. <a href="../../../provider/onboardbase/" class="md-nav__link">
  1013. <span class="md-ellipsis">
  1014. Onboardbase
  1015. </span>
  1016. </a>
  1017. </li>
  1018. <li class="md-nav__item">
  1019. <a href="../../../provider-passworddepot/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Password Depot
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="../../../provider/fortanix/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Fortanix
  1029. </span>
  1030. </a>
  1031. </li>
  1032. <li class="md-nav__item">
  1033. <a href="../../../provider/infisical/" class="md-nav__link">
  1034. <span class="md-ellipsis">
  1035. Infisical
  1036. </span>
  1037. </a>
  1038. </li>
  1039. <li class="md-nav__item">
  1040. <a href="../../../provider/previder/" class="md-nav__link">
  1041. <span class="md-ellipsis">
  1042. Previder
  1043. </span>
  1044. </a>
  1045. </li>
  1046. <li class="md-nav__item">
  1047. <a href="../../../provider/openbao/" class="md-nav__link">
  1048. <span class="md-ellipsis">
  1049. OpenBao
  1050. </span>
  1051. </a>
  1052. </li>
  1053. </ul>
  1054. </nav>
  1055. </li>
  1056. <li class="md-nav__item md-nav__item--nested">
  1057. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1058. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1059. <span class="md-ellipsis">
  1060. Examples
  1061. </span>
  1062. <span class="md-nav__icon md-icon"></span>
  1063. </label>
  1064. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1065. <label class="md-nav__title" for="__nav_5">
  1066. <span class="md-nav__icon md-icon"></span>
  1067. Examples
  1068. </label>
  1069. <ul class="md-nav__list" data-md-scrollfix>
  1070. <li class="md-nav__item">
  1071. <a href="../../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. FluxCD
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="../../../examples/anchore-engine-credentials/" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Anchore Engine
  1081. </span>
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="../../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Jenkins
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="../../../examples/bitwarden/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Bitwarden
  1095. </span>
  1096. </a>
  1097. </li>
  1098. </ul>
  1099. </nav>
  1100. </li>
  1101. <li class="md-nav__item md-nav__item--nested">
  1102. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1103. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1104. <span class="md-ellipsis">
  1105. Community
  1106. </span>
  1107. <span class="md-nav__icon md-icon"></span>
  1108. </label>
  1109. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1110. <label class="md-nav__title" for="__nav_6">
  1111. <span class="md-nav__icon md-icon"></span>
  1112. Community
  1113. </label>
  1114. <ul class="md-nav__list" data-md-scrollfix>
  1115. <li class="md-nav__item md-nav__item--nested">
  1116. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1117. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1118. <span class="md-ellipsis">
  1119. Contributing
  1120. </span>
  1121. <span class="md-nav__icon md-icon"></span>
  1122. </label>
  1123. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1124. <label class="md-nav__title" for="__nav_6_1">
  1125. <span class="md-nav__icon md-icon"></span>
  1126. Contributing
  1127. </label>
  1128. <ul class="md-nav__list" data-md-scrollfix>
  1129. <li class="md-nav__item">
  1130. <a href="../../../contributing/devguide/" class="md-nav__link">
  1131. <span class="md-ellipsis">
  1132. Developer guide
  1133. </span>
  1134. </a>
  1135. </li>
  1136. <li class="md-nav__item">
  1137. <a href="../../../contributing/process/" class="md-nav__link">
  1138. <span class="md-ellipsis">
  1139. Contributing Process
  1140. </span>
  1141. </a>
  1142. </li>
  1143. <li class="md-nav__item">
  1144. <a href="../../../contributing/release/" class="md-nav__link">
  1145. <span class="md-ellipsis">
  1146. Release Process
  1147. </span>
  1148. </a>
  1149. </li>
  1150. <li class="md-nav__item">
  1151. <a href="../../../contributing/coc/" class="md-nav__link">
  1152. <span class="md-ellipsis">
  1153. Code of Conduct
  1154. </span>
  1155. </a>
  1156. </li>
  1157. <li class="md-nav__item">
  1158. <a href="../../../contributing/calendar/" class="md-nav__link">
  1159. <span class="md-ellipsis">
  1160. Community meetings calendar
  1161. </span>
  1162. </a>
  1163. </li>
  1164. <li class="md-nav__item">
  1165. <a href="../../../contributing/roadmap/" class="md-nav__link">
  1166. <span class="md-ellipsis">
  1167. Roadmap
  1168. </span>
  1169. </a>
  1170. </li>
  1171. </ul>
  1172. </nav>
  1173. </li>
  1174. <li class="md-nav__item md-nav__item--nested">
  1175. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1176. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1177. <span class="md-ellipsis">
  1178. External Resources
  1179. </span>
  1180. <span class="md-nav__icon md-icon"></span>
  1181. </label>
  1182. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1183. <label class="md-nav__title" for="__nav_6_2">
  1184. <span class="md-nav__icon md-icon"></span>
  1185. External Resources
  1186. </label>
  1187. <ul class="md-nav__list" data-md-scrollfix>
  1188. <li class="md-nav__item">
  1189. <a href="../../../eso-talks/" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. Talks
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="../../../eso-demos/" class="md-nav__link">
  1197. <span class="md-ellipsis">
  1198. Demos
  1199. </span>
  1200. </a>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="../../../eso-blogs/" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Blogs
  1206. </span>
  1207. </a>
  1208. </li>
  1209. <li class="md-nav__item">
  1210. <a href="../../../eso-tools/" class="md-nav__link">
  1211. <span class="md-ellipsis">
  1212. Tools
  1213. </span>
  1214. </a>
  1215. </li>
  1216. </ul>
  1217. </nav>
  1218. </li>
  1219. </ul>
  1220. </nav>
  1221. </li>
  1222. </ul>
  1223. </nav>
  1224. </div>
  1225. </div>
  1226. </div>
  1227. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1228. <div class="md-sidebar__scrollwrap">
  1229. <div class="md-sidebar__inner">
  1230. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1231. <label class="md-nav__title" for="__toc">
  1232. <span class="md-nav__icon md-icon"></span>
  1233. Table of contents
  1234. </label>
  1235. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1236. <li class="md-nav__item">
  1237. <a href="#github-app-authentication-documentation" class="md-nav__link">
  1238. <span class="md-ellipsis">
  1239. GitHub App Authentication Documentation
  1240. </span>
  1241. </a>
  1242. <nav class="md-nav" aria-label="GitHub App Authentication Documentation">
  1243. <ul class="md-nav__list">
  1244. <li class="md-nav__item">
  1245. <a href="#1-register-a-github-app" class="md-nav__link">
  1246. <span class="md-ellipsis">
  1247. 1. Register a GitHub App
  1248. </span>
  1249. </a>
  1250. </li>
  1251. <li class="md-nav__item">
  1252. <a href="#2-store-the-private-key" class="md-nav__link">
  1253. <span class="md-ellipsis">
  1254. 2. Store the Private Key
  1255. </span>
  1256. </a>
  1257. </li>
  1258. <li class="md-nav__item">
  1259. <a href="#3-set-permissions-for-the-github-app" class="md-nav__link">
  1260. <span class="md-ellipsis">
  1261. 3. Set Permissions for the GitHub App
  1262. </span>
  1263. </a>
  1264. </li>
  1265. <li class="md-nav__item">
  1266. <a href="#4-install-your-github-app" class="md-nav__link">
  1267. <span class="md-ellipsis">
  1268. 4. Install Your GitHub App
  1269. </span>
  1270. </a>
  1271. </li>
  1272. <li class="md-nav__item">
  1273. <a href="#5-obtain-an-installation-id" class="md-nav__link">
  1274. <span class="md-ellipsis">
  1275. 5. Obtain an Installation ID
  1276. </span>
  1277. </a>
  1278. </li>
  1279. <li class="md-nav__item">
  1280. <a href="#example-kubernetes-manifest-for-github-access-token-generator" class="md-nav__link">
  1281. <span class="md-ellipsis">
  1282. Example Kubernetes Manifest for GitHub Access Token Generator
  1283. </span>
  1284. </a>
  1285. </li>
  1286. <li class="md-nav__item">
  1287. <a href="#notes" class="md-nav__link">
  1288. <span class="md-ellipsis">
  1289. Notes
  1290. </span>
  1291. </a>
  1292. </li>
  1293. </ul>
  1294. </nav>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </div>
  1299. </div>
  1300. </div>
  1301. <div class="md-content" data-md-component="content">
  1302. <article class="md-content__inner md-typeset">
  1303. <h1>Github</h1>
  1304. <h2 id="github-app-authentication-documentation">GitHub App Authentication Documentation</h2>
  1305. <h3 id="1-register-a-github-app">1. Register a GitHub App</h3>
  1306. <p>To create a GitHub app, follow the instructions provided by GitHub:</p>
  1307. <ul>
  1308. <li><strong>Visit</strong>: <a href="https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app#registering-a-github-app">Registering a GitHub App</a></li>
  1309. <li><strong>Procedure</strong>:</li>
  1310. <li>Fill in the necessary details for your app.</li>
  1311. <li>Note the <code>App ID</code> provided after registration.</li>
  1312. <li>At the bottom of the registration page, click on <code>Generate a private key</code>. Download and securely store this key.</li>
  1313. </ul>
  1314. <h3 id="2-store-the-private-key">2. Store the Private Key</h3>
  1315. <p>After generating your private key, you need to store it securely. If you are using Kubernetes, you can store it as a secret:</p>
  1316. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>github-app-pem<span class="w"> </span>--from-file<span class="o">=</span><span class="nv">key</span><span class="o">=</span>path/to/your/private-key.pem
  1317. </code></pre></div>
  1318. <h3 id="3-set-permissions-for-the-github-app">3. Set Permissions for the GitHub App</h3>
  1319. <p>Configure the necessary permissions for your GitHub app depending on what actions it needs to perform:</p>
  1320. <ul>
  1321. <li><strong>Visit</strong>: <a href="https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app#choosing-permissions-for-rest-api-access">Choosing Permissions for a GitHub App</a></li>
  1322. <li><strong>Example</strong>:</li>
  1323. <li>For managing OCI images, set read and write permissions for packages.</li>
  1324. </ul>
  1325. <h3 id="4-install-your-github-app">4. Install Your GitHub App</h3>
  1326. <p>Install the GitHub app on your repository or organization to start using it:</p>
  1327. <ul>
  1328. <li><strong>Visit</strong>: <a href="https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app">Installing Your Own GitHub App</a></li>
  1329. </ul>
  1330. <h3 id="5-obtain-an-installation-id">5. Obtain an Installation ID</h3>
  1331. <p>After installation, you need to get the installation ID to authenticate API requests:</p>
  1332. <ul>
  1333. <li><strong>Visit</strong>: <a href="https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app#generating-an-installation-access-token">Generating an Installation Access Token for a GitHub App</a></li>
  1334. <li><strong>Procedure</strong>:</li>
  1335. <li>Find the installation ID from the URL or API response.</li>
  1336. </ul>
  1337. <h3 id="example-kubernetes-manifest-for-github-access-token-generator">Example Kubernetes Manifest for GitHub Access Token Generator</h3>
  1338. <div class="highlight"><pre><span></span><code><span class="c1"># 1. Register Github app https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app#registering-a-github-app</span>
  1339. <span class="c1"># `App ID: 123456` will be displayed after you create an app. Next on the bottom of the page, you&#39;ll find `Generate a private key` button.</span>
  1340. <span class="c1"># 2. Get privateKey https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps#generating-private-keys put it in e.g `github-app-pem` k8s secret</span>
  1341. <span class="c1"># 3. Set permissions for the app, e.g if you want to push OCI images to ghr set RW for packages https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app#choosing-permissions-for-rest-api-access</span>
  1342. <span class="c1"># 4. Install your Github app https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app</span>
  1343. <span class="c1"># 5. Get `installID` https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app#generating-an-installation-access-token (2)</span>
  1344. <span class="nn">---</span>
  1345. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1346. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GithubAccessToken</span>
  1347. <span class="nt">metadata</span><span class="p">:</span>
  1348. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-token</span>
  1349. <span class="nt">spec</span><span class="p">:</span>
  1350. <span class="w"> </span><span class="nt">appID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;0000000&quot;</span><span class="w"> </span><span class="c1"># (1)</span>
  1351. <span class="w"> </span><span class="nt">installID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;00000000&quot;</span><span class="w"> </span><span class="c1"># (5)</span>
  1352. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="c1"># (Default https://api.github.com.)</span>
  1353. <span class="w"> </span><span class="nt">repositories</span><span class="p">:</span><span class="w"> </span><span class="c1"># Optional</span>
  1354. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;Hello-World&quot;</span>
  1355. <span class="w"> </span><span class="nt">permissions</span><span class="p">:</span><span class="w"> </span><span class="c1"># Optional</span>
  1356. <span class="w"> </span><span class="nt">contents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
  1357. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1358. <span class="w"> </span><span class="nt">privateKey</span><span class="p">:</span>
  1359. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1360. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-app-pem</span><span class="w"> </span><span class="c1"># (2)</span>
  1361. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">key</span>
  1362. </code></pre></div>
  1363. <div class="highlight"><pre><span></span><code><span class="nn">---</span>
  1364. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1</span>
  1365. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1366. <span class="nt">metadata</span><span class="p">:</span>
  1367. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-token</span>
  1368. <span class="nt">spec</span><span class="p">:</span>
  1369. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;30m&quot;</span>
  1370. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1371. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-token</span><span class="w"> </span><span class="c1"># Name for the secret to be created on the cluster</span>
  1372. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1373. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1374. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1375. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1376. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GithubAccessToken</span>
  1377. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-token</span>
  1378. </code></pre></div>
  1379. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1</span>
  1380. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1381. <span class="nt">metadata</span><span class="p">:</span>
  1382. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-template</span>
  1383. <span class="nt">spec</span><span class="p">:</span>
  1384. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1385. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1386. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1387. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1388. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GithubAccessToken</span>
  1389. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-token</span>
  1390. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15m&quot;</span>
  1391. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1392. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1393. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1394. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1395. <span class="w"> </span><span class="nt">tekton.dev/git-0</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://github.com&quot;</span>
  1396. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.io/basic-auth</span>
  1397. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1398. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1399. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span>
  1400. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.token</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1401. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github-auth-template</span>
  1402. </code></pre></div>
  1403. <h3 id="notes">Notes</h3>
  1404. <ul>
  1405. <li>Ensure that all sensitive data such as private keys and IDs are securely handled and stored.</li>
  1406. <li>Adjust the permissions and configurations according to your specific requirements and security policies.</li>
  1407. </ul>
  1408. </article>
  1409. </div>
  1410. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1411. </div>
  1412. </main>
  1413. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1414. <footer class="md-footer">
  1415. <div class="md-footer-meta md-typeset">
  1416. <div class="md-footer-meta__inner md-grid">
  1417. <div class="md-copyright">
  1418. <div class="md-copyright__highlight">
  1419. &copy; 2025 The external-secrets Authors.<br/>
  1420. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1421. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1422. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1423. </div>
  1424. Made with
  1425. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1426. Material for MkDocs
  1427. </a>
  1428. </div>
  1429. </div>
  1430. </div>
  1431. </footer>
  1432. </div>
  1433. <div class="md-dialog" data-md-component="dialog">
  1434. <div class="md-dialog__inner md-typeset"></div>
  1435. </div>
  1436. <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1437. <script src="../../../assets/javascripts/bundle.13a4f30d.min.js"></script>
  1438. </body>
  1439. </html>