index.html 123 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887
  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="../device42/">
  7. <link rel="next" href="../hashicorp-vault/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
  10. <title>Google Cloud Secret Manager - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.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="#authentication" 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. Google Cloud Secret Manager
  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 7.1.0 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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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">
  127. <a href="../../api/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 md-tabs__item--active">
  137. <a href="../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 7.1.0 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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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--nested">
  248. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  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="false">
  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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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--nested">
  328. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  329. <div class="md-nav__link md-nav__container">
  330. <a href="../../api/generator/" 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="false">
  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="../../api/generator/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="../../api/generator/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="../../api/generator/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="../../api/generator/cloudsmith/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Cloudsmith
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/cluster/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Cluster Generator
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/gcr/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Google Container Registry
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/quay/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Quay
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/vault/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Vault Dynamic Secret
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/password/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Password
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/fake/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Fake
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/webhook/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Webhook
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/github/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Github
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../api/generator/uuid/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. UUID
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/generator/mfa/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. MFA
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/generator/sshkey/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. SSHKey
  447. </span>
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  455. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  456. <span class="md-ellipsis">
  457. Reference Docs
  458. </span>
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_2_4">
  463. <span class="md-nav__icon md-icon"></span>
  464. Reference Docs
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../api/spec/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. API specification
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../api/controller-options/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. Controller Options
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../api/metrics/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Metrics
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../api/selectable-fields/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Selectable Fields
  492. </span>
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  503. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  504. <span class="md-ellipsis">
  505. Guides
  506. </span>
  507. <span class="md-nav__icon md-icon"></span>
  508. </label>
  509. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  510. <label class="md-nav__title" for="__nav_3">
  511. <span class="md-nav__icon md-icon"></span>
  512. Guides
  513. </label>
  514. <ul class="md-nav__list" data-md-scrollfix>
  515. <li class="md-nav__item">
  516. <a href="../../guides/introduction/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Introduction
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item md-nav__item--nested">
  523. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  524. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  525. <span class="md-ellipsis">
  526. External Secrets
  527. </span>
  528. <span class="md-nav__icon md-icon"></span>
  529. </label>
  530. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  531. <label class="md-nav__title" for="__nav_3_2">
  532. <span class="md-nav__icon md-icon"></span>
  533. External Secrets
  534. </label>
  535. <ul class="md-nav__list" data-md-scrollfix>
  536. <li class="md-nav__item">
  537. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Extract structured data
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/getallsecrets/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Find Secrets by Name or Metadata
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Rewriting Keys
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item md-nav__item--nested">
  558. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  559. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  560. <span class="md-ellipsis">
  561. Advanced Templating
  562. </span>
  563. <span class="md-nav__icon md-icon"></span>
  564. </label>
  565. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  566. <label class="md-nav__title" for="__nav_3_2_4">
  567. <span class="md-nav__icon md-icon"></span>
  568. Advanced Templating
  569. </label>
  570. <ul class="md-nav__list" data-md-scrollfix>
  571. <li class="md-nav__item">
  572. <a href="../../guides/templating/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. v2
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/templating-v1/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. v1
  582. </span>
  583. </a>
  584. </li>
  585. </ul>
  586. </nav>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Kubernetes Secret Types
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Lifecycle: ownership & deletion
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Decoding Strategies
  606. </span>
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/controller-class/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Controller Classes
  613. </span>
  614. </a>
  615. </li>
  616. </ul>
  617. </nav>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/generator/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Generators
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/pushsecrets/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Push Secrets
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item md-nav__item--nested">
  634. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  635. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  636. <span class="md-ellipsis">
  637. Operations
  638. </span>
  639. <span class="md-nav__icon md-icon"></span>
  640. </label>
  641. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  642. <label class="md-nav__title" for="__nav_3_5">
  643. <span class="md-nav__icon md-icon"></span>
  644. Operations
  645. </label>
  646. <ul class="md-nav__list" data-md-scrollfix>
  647. <li class="md-nav__item">
  648. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Multi Tenancy
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../guides/security-best-practices/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Security Best Practices
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../guides/threat-model/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Threat Model
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../guides/v1beta1/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. Upgrading to v1beta1
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../guides/using-latest-image/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Using Latest Image
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Disable Cluster Features
  686. </span>
  687. </a>
  688. </li>
  689. </ul>
  690. </nav>
  691. </li>
  692. <li class="md-nav__item md-nav__item--nested">
  693. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  694. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  695. <span class="md-ellipsis">
  696. Tooling
  697. </span>
  698. <span class="md-nav__icon md-icon"></span>
  699. </label>
  700. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  701. <label class="md-nav__title" for="__nav_3_6">
  702. <span class="md-nav__icon md-icon"></span>
  703. Tooling
  704. </label>
  705. <ul class="md-nav__list" data-md-scrollfix>
  706. <li class="md-nav__item">
  707. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Using the esoctl tool
  710. </span>
  711. </a>
  712. </li>
  713. </ul>
  714. </nav>
  715. </li>
  716. </ul>
  717. </nav>
  718. </li>
  719. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  720. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  721. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  722. <span class="md-ellipsis">
  723. Provider
  724. </span>
  725. <span class="md-nav__icon md-icon"></span>
  726. </label>
  727. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  728. <label class="md-nav__title" for="__nav_4">
  729. <span class="md-nav__icon md-icon"></span>
  730. Provider
  731. </label>
  732. <ul class="md-nav__list" data-md-scrollfix>
  733. <li class="md-nav__item">
  734. <a href="../aws-secrets-manager/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. AWS Secrets Manager
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../aws-parameter-store/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. AWS Parameter Store
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../azure-key-vault/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Azure Key Vault
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../beyondtrust/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. BeyondTrust
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Bitwarden Secrets Manager
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../chef/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Chef
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../cloudru/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. Cloud.ru Secret Manager
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../conjur/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. CyberArk Conjur
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../device42/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Device42
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item md-nav__item--active">
  797. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  798. <label class="md-nav__link md-nav__link--active" for="__toc">
  799. <span class="md-ellipsis">
  800. Google Cloud Secret Manager
  801. </span>
  802. <span class="md-nav__icon md-icon"></span>
  803. </label>
  804. <a href="./" class="md-nav__link md-nav__link--active">
  805. <span class="md-ellipsis">
  806. Google Cloud Secret Manager
  807. </span>
  808. </a>
  809. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  810. <label class="md-nav__title" for="__toc">
  811. <span class="md-nav__icon md-icon"></span>
  812. Table of contents
  813. </label>
  814. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  815. <li class="md-nav__item">
  816. <a href="#authentication" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Authentication
  819. </span>
  820. </a>
  821. <nav class="md-nav" aria-label="Authentication">
  822. <ul class="md-nav__list">
  823. <li class="md-nav__item">
  824. <a href="#workload-identity-federation" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Workload Identity Federation
  827. </span>
  828. </a>
  829. <nav class="md-nav" aria-label="Workload Identity Federation">
  830. <ul class="md-nav__list">
  831. <li class="md-nav__item">
  832. <a href="#prerequisites" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. Prerequisites
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="#using-a-kubernetes-service-account-as-a-gcp-iam-principal" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. Using a Kubernetes service account as a GCP IAM principal
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="#linking-a-kubernetes-service-account-to-a-gcp-service-account" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. Linking a Kubernetes service account to a GCP service account
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="#authorizing-the-core-controller-pod" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Authorizing the Core Controller Pod
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="#explicitly-specifying-the-gke-clusters-name-and-location" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Explicitly specifying the GKE cluster's name and location
  863. </span>
  864. </a>
  865. </li>
  866. </ul>
  867. </nav>
  868. </li>
  869. <li class="md-nav__item">
  870. <a href="#authenticating-with-a-gcp-service-account" class="md-nav__link">
  871. <span class="md-ellipsis">
  872. Authenticating with a GCP service account
  873. </span>
  874. </a>
  875. </li>
  876. </ul>
  877. </nav>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="#using-pushsecret-with-an-existing-google-secret-manager-secret" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Using PushSecret with an existing Google Secret Manager secret
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="#secret-replication-and-encryption-configuration" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Secret Replication and Encryption Configuration
  890. </span>
  891. </a>
  892. <nav class="md-nav" aria-label="Secret Replication and Encryption Configuration">
  893. <ul class="md-nav__list">
  894. <li class="md-nav__item">
  895. <a href="#location-and-replication" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Location and Replication
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="#customer-managed-encryption-keys-cmek" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Customer-Managed Encryption Keys (CMEK)
  905. </span>
  906. </a>
  907. </li>
  908. </ul>
  909. </nav>
  910. </li>
  911. <li class="md-nav__item">
  912. <a href="#regional-secrets" class="md-nav__link">
  913. <span class="md-ellipsis">
  914. Regional Secrets
  915. </span>
  916. </a>
  917. </li>
  918. <li class="md-nav__item">
  919. <a href="#secret-version-management" class="md-nav__link">
  920. <span class="md-ellipsis">
  921. Secret Version Management
  922. </span>
  923. </a>
  924. <nav class="md-nav" aria-label="Secret Version Management">
  925. <ul class="md-nav__list">
  926. <li class="md-nav__item">
  927. <a href="#secret-version-selection-policy" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Secret Version Selection Policy
  930. </span>
  931. </a>
  932. <nav class="md-nav" aria-label="Secret Version Selection Policy">
  933. <ul class="md-nav__list">
  934. <li class="md-nav__item">
  935. <a href="#available-policies" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Available Policies
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="#configuration-example" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. Configuration Example
  945. </span>
  946. </a>
  947. </li>
  948. </ul>
  949. </nav>
  950. </li>
  951. </ul>
  952. </nav>
  953. </li>
  954. </ul>
  955. </nav>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../hashicorp-vault/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. HashiCorp Vault
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item">
  965. <a href="../kubernetes/" class="md-nav__link">
  966. <span class="md-ellipsis">
  967. Kubernetes
  968. </span>
  969. </a>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="../ibm-secrets-manager/" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. IBM Secrets Manager
  975. </span>
  976. </a>
  977. </li>
  978. <li class="md-nav__item">
  979. <a href="../akeyless/" class="md-nav__link">
  980. <span class="md-ellipsis">
  981. Akeyless
  982. </span>
  983. </a>
  984. </li>
  985. <li class="md-nav__item">
  986. <a href="../yandex-certificate-manager/" class="md-nav__link">
  987. <span class="md-ellipsis">
  988. Yandex Certificate Manager
  989. </span>
  990. </a>
  991. </li>
  992. <li class="md-nav__item">
  993. <a href="../yandex-lockbox/" class="md-nav__link">
  994. <span class="md-ellipsis">
  995. Yandex Lockbox
  996. </span>
  997. </a>
  998. </li>
  999. <li class="md-nav__item">
  1000. <a href="../alibaba/" class="md-nav__link">
  1001. <span class="md-ellipsis">
  1002. Alibaba Cloud
  1003. </span>
  1004. </a>
  1005. </li>
  1006. <li class="md-nav__item">
  1007. <a href="../gitlab-variables/" class="md-nav__link">
  1008. <span class="md-ellipsis">
  1009. GitLab Variables
  1010. </span>
  1011. </a>
  1012. </li>
  1013. <li class="md-nav__item">
  1014. <a href="../github/" class="md-nav__link">
  1015. <span class="md-ellipsis">
  1016. Github Actions Secrets
  1017. </span>
  1018. </a>
  1019. </li>
  1020. <li class="md-nav__item">
  1021. <a href="../oracle-vault/" class="md-nav__link">
  1022. <span class="md-ellipsis">
  1023. Oracle Vault
  1024. </span>
  1025. </a>
  1026. </li>
  1027. <li class="md-nav__item">
  1028. <a href="../1password-automation/" class="md-nav__link">
  1029. <span class="md-ellipsis">
  1030. 1Password Connect Server
  1031. </span>
  1032. </a>
  1033. </li>
  1034. <li class="md-nav__item">
  1035. <a href="../1password-sdk/" class="md-nav__link">
  1036. <span class="md-ellipsis">
  1037. 1Password SDK
  1038. </span>
  1039. </a>
  1040. </li>
  1041. <li class="md-nav__item">
  1042. <a href="../webhook/" class="md-nav__link">
  1043. <span class="md-ellipsis">
  1044. Webhook
  1045. </span>
  1046. </a>
  1047. </li>
  1048. <li class="md-nav__item">
  1049. <a href="../fake/" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. Fake
  1052. </span>
  1053. </a>
  1054. </li>
  1055. <li class="md-nav__item">
  1056. <a href="../senhasegura-dsm/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. senhasegura DevOps Secrets Management (DSM)
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../doppler/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Doppler
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../keeper-security/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Keeper Security
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../cloak/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Cloak End 2 End Encrypted Secrets
  1080. </span>
  1081. </a>
  1082. </li>
  1083. <li class="md-nav__item">
  1084. <a href="../scaleway/" class="md-nav__link">
  1085. <span class="md-ellipsis">
  1086. Scaleway
  1087. </span>
  1088. </a>
  1089. </li>
  1090. <li class="md-nav__item">
  1091. <a href="../delinea/" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. Delinea
  1094. </span>
  1095. </a>
  1096. </li>
  1097. <li class="md-nav__item">
  1098. <a href="../secretserver/" class="md-nav__link">
  1099. <span class="md-ellipsis">
  1100. Secret Server
  1101. </span>
  1102. </a>
  1103. </li>
  1104. <li class="md-nav__item">
  1105. <a href="../passbolt/" class="md-nav__link">
  1106. <span class="md-ellipsis">
  1107. Passbolt
  1108. </span>
  1109. </a>
  1110. </li>
  1111. <li class="md-nav__item">
  1112. <a href="../pulumi/" class="md-nav__link">
  1113. <span class="md-ellipsis">
  1114. Pulumi ESC
  1115. </span>
  1116. </a>
  1117. </li>
  1118. <li class="md-nav__item">
  1119. <a href="../onboardbase/" class="md-nav__link">
  1120. <span class="md-ellipsis">
  1121. Onboardbase
  1122. </span>
  1123. </a>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="../../provider-passworddepot/" class="md-nav__link">
  1127. <span class="md-ellipsis">
  1128. Password Depot
  1129. </span>
  1130. </a>
  1131. </li>
  1132. <li class="md-nav__item">
  1133. <a href="../fortanix/" class="md-nav__link">
  1134. <span class="md-ellipsis">
  1135. Fortanix
  1136. </span>
  1137. </a>
  1138. </li>
  1139. <li class="md-nav__item">
  1140. <a href="../infisical/" class="md-nav__link">
  1141. <span class="md-ellipsis">
  1142. Infisical
  1143. </span>
  1144. </a>
  1145. </li>
  1146. <li class="md-nav__item">
  1147. <a href="../previder/" class="md-nav__link">
  1148. <span class="md-ellipsis">
  1149. Previder
  1150. </span>
  1151. </a>
  1152. </li>
  1153. <li class="md-nav__item">
  1154. <a href="../openbao/" class="md-nav__link">
  1155. <span class="md-ellipsis">
  1156. OpenBao
  1157. </span>
  1158. </a>
  1159. </li>
  1160. <li class="md-nav__item">
  1161. <a href="../volcengine/" class="md-nav__link">
  1162. <span class="md-ellipsis">
  1163. Volcengine
  1164. </span>
  1165. </a>
  1166. </li>
  1167. <li class="md-nav__item">
  1168. <a href="../ngrok/" class="md-nav__link">
  1169. <span class="md-ellipsis">
  1170. ngrok
  1171. </span>
  1172. </a>
  1173. </li>
  1174. </ul>
  1175. </nav>
  1176. </li>
  1177. <li class="md-nav__item md-nav__item--nested">
  1178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1179. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1180. <span class="md-ellipsis">
  1181. Examples
  1182. </span>
  1183. <span class="md-nav__icon md-icon"></span>
  1184. </label>
  1185. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1186. <label class="md-nav__title" for="__nav_5">
  1187. <span class="md-nav__icon md-icon"></span>
  1188. Examples
  1189. </label>
  1190. <ul class="md-nav__list" data-md-scrollfix>
  1191. <li class="md-nav__item">
  1192. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1193. <span class="md-ellipsis">
  1194. FluxCD
  1195. </span>
  1196. </a>
  1197. </li>
  1198. <li class="md-nav__item">
  1199. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1200. <span class="md-ellipsis">
  1201. Anchore Engine
  1202. </span>
  1203. </a>
  1204. </li>
  1205. <li class="md-nav__item">
  1206. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1207. <span class="md-ellipsis">
  1208. Jenkins
  1209. </span>
  1210. </a>
  1211. </li>
  1212. <li class="md-nav__item">
  1213. <a href="../../examples/bitwarden/" class="md-nav__link">
  1214. <span class="md-ellipsis">
  1215. Bitwarden
  1216. </span>
  1217. </a>
  1218. </li>
  1219. </ul>
  1220. </nav>
  1221. </li>
  1222. <li class="md-nav__item md-nav__item--nested">
  1223. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1224. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1225. <span class="md-ellipsis">
  1226. Community
  1227. </span>
  1228. <span class="md-nav__icon md-icon"></span>
  1229. </label>
  1230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1231. <label class="md-nav__title" for="__nav_6">
  1232. <span class="md-nav__icon md-icon"></span>
  1233. Community
  1234. </label>
  1235. <ul class="md-nav__list" data-md-scrollfix>
  1236. <li class="md-nav__item md-nav__item--nested">
  1237. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1238. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1239. <span class="md-ellipsis">
  1240. Contributing
  1241. </span>
  1242. <span class="md-nav__icon md-icon"></span>
  1243. </label>
  1244. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1245. <label class="md-nav__title" for="__nav_6_1">
  1246. <span class="md-nav__icon md-icon"></span>
  1247. Contributing
  1248. </label>
  1249. <ul class="md-nav__list" data-md-scrollfix>
  1250. <li class="md-nav__item">
  1251. <a href="../../contributing/devguide/" class="md-nav__link">
  1252. <span class="md-ellipsis">
  1253. Developer guide
  1254. </span>
  1255. </a>
  1256. </li>
  1257. <li class="md-nav__item">
  1258. <a href="../../contributing/process/" class="md-nav__link">
  1259. <span class="md-ellipsis">
  1260. Contributing Process
  1261. </span>
  1262. </a>
  1263. </li>
  1264. <li class="md-nav__item">
  1265. <a href="../../contributing/release/" class="md-nav__link">
  1266. <span class="md-ellipsis">
  1267. Release Process
  1268. </span>
  1269. </a>
  1270. </li>
  1271. <li class="md-nav__item">
  1272. <a href="../../contributing/coc/" class="md-nav__link">
  1273. <span class="md-ellipsis">
  1274. Code of Conduct
  1275. </span>
  1276. </a>
  1277. </li>
  1278. <li class="md-nav__item">
  1279. <a href="../../contributing/calendar/" class="md-nav__link">
  1280. <span class="md-ellipsis">
  1281. Community meetings calendar
  1282. </span>
  1283. </a>
  1284. </li>
  1285. <li class="md-nav__item">
  1286. <a href="../../contributing/roadmap/" class="md-nav__link">
  1287. <span class="md-ellipsis">
  1288. Roadmap
  1289. </span>
  1290. </a>
  1291. </li>
  1292. <li class="md-nav__item">
  1293. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1294. <span class="md-ellipsis">
  1295. Burnout Prevention
  1296. </span>
  1297. </a>
  1298. </li>
  1299. </ul>
  1300. </nav>
  1301. </li>
  1302. <li class="md-nav__item md-nav__item--nested">
  1303. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1304. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1305. <span class="md-ellipsis">
  1306. External Resources
  1307. </span>
  1308. <span class="md-nav__icon md-icon"></span>
  1309. </label>
  1310. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1311. <label class="md-nav__title" for="__nav_6_2">
  1312. <span class="md-nav__icon md-icon"></span>
  1313. External Resources
  1314. </label>
  1315. <ul class="md-nav__list" data-md-scrollfix>
  1316. <li class="md-nav__item">
  1317. <a href="../../eso-talks/" class="md-nav__link">
  1318. <span class="md-ellipsis">
  1319. Talks
  1320. </span>
  1321. </a>
  1322. </li>
  1323. <li class="md-nav__item">
  1324. <a href="../../eso-demos/" class="md-nav__link">
  1325. <span class="md-ellipsis">
  1326. Demos
  1327. </span>
  1328. </a>
  1329. </li>
  1330. <li class="md-nav__item">
  1331. <a href="../../eso-blogs/" class="md-nav__link">
  1332. <span class="md-ellipsis">
  1333. Blogs
  1334. </span>
  1335. </a>
  1336. </li>
  1337. <li class="md-nav__item">
  1338. <a href="../../eso-tools/" class="md-nav__link">
  1339. <span class="md-ellipsis">
  1340. Tools
  1341. </span>
  1342. </a>
  1343. </li>
  1344. </ul>
  1345. </nav>
  1346. </li>
  1347. </ul>
  1348. </nav>
  1349. </li>
  1350. </ul>
  1351. </nav>
  1352. </div>
  1353. </div>
  1354. </div>
  1355. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1356. <div class="md-sidebar__scrollwrap">
  1357. <div class="md-sidebar__inner">
  1358. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1359. <label class="md-nav__title" for="__toc">
  1360. <span class="md-nav__icon md-icon"></span>
  1361. Table of contents
  1362. </label>
  1363. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1364. <li class="md-nav__item">
  1365. <a href="#authentication" class="md-nav__link">
  1366. <span class="md-ellipsis">
  1367. Authentication
  1368. </span>
  1369. </a>
  1370. <nav class="md-nav" aria-label="Authentication">
  1371. <ul class="md-nav__list">
  1372. <li class="md-nav__item">
  1373. <a href="#workload-identity-federation" class="md-nav__link">
  1374. <span class="md-ellipsis">
  1375. Workload Identity Federation
  1376. </span>
  1377. </a>
  1378. <nav class="md-nav" aria-label="Workload Identity Federation">
  1379. <ul class="md-nav__list">
  1380. <li class="md-nav__item">
  1381. <a href="#prerequisites" class="md-nav__link">
  1382. <span class="md-ellipsis">
  1383. Prerequisites
  1384. </span>
  1385. </a>
  1386. </li>
  1387. <li class="md-nav__item">
  1388. <a href="#using-a-kubernetes-service-account-as-a-gcp-iam-principal" class="md-nav__link">
  1389. <span class="md-ellipsis">
  1390. Using a Kubernetes service account as a GCP IAM principal
  1391. </span>
  1392. </a>
  1393. </li>
  1394. <li class="md-nav__item">
  1395. <a href="#linking-a-kubernetes-service-account-to-a-gcp-service-account" class="md-nav__link">
  1396. <span class="md-ellipsis">
  1397. Linking a Kubernetes service account to a GCP service account
  1398. </span>
  1399. </a>
  1400. </li>
  1401. <li class="md-nav__item">
  1402. <a href="#authorizing-the-core-controller-pod" class="md-nav__link">
  1403. <span class="md-ellipsis">
  1404. Authorizing the Core Controller Pod
  1405. </span>
  1406. </a>
  1407. </li>
  1408. <li class="md-nav__item">
  1409. <a href="#explicitly-specifying-the-gke-clusters-name-and-location" class="md-nav__link">
  1410. <span class="md-ellipsis">
  1411. Explicitly specifying the GKE cluster's name and location
  1412. </span>
  1413. </a>
  1414. </li>
  1415. </ul>
  1416. </nav>
  1417. </li>
  1418. <li class="md-nav__item">
  1419. <a href="#authenticating-with-a-gcp-service-account" class="md-nav__link">
  1420. <span class="md-ellipsis">
  1421. Authenticating with a GCP service account
  1422. </span>
  1423. </a>
  1424. </li>
  1425. </ul>
  1426. </nav>
  1427. </li>
  1428. <li class="md-nav__item">
  1429. <a href="#using-pushsecret-with-an-existing-google-secret-manager-secret" class="md-nav__link">
  1430. <span class="md-ellipsis">
  1431. Using PushSecret with an existing Google Secret Manager secret
  1432. </span>
  1433. </a>
  1434. </li>
  1435. <li class="md-nav__item">
  1436. <a href="#secret-replication-and-encryption-configuration" class="md-nav__link">
  1437. <span class="md-ellipsis">
  1438. Secret Replication and Encryption Configuration
  1439. </span>
  1440. </a>
  1441. <nav class="md-nav" aria-label="Secret Replication and Encryption Configuration">
  1442. <ul class="md-nav__list">
  1443. <li class="md-nav__item">
  1444. <a href="#location-and-replication" class="md-nav__link">
  1445. <span class="md-ellipsis">
  1446. Location and Replication
  1447. </span>
  1448. </a>
  1449. </li>
  1450. <li class="md-nav__item">
  1451. <a href="#customer-managed-encryption-keys-cmek" class="md-nav__link">
  1452. <span class="md-ellipsis">
  1453. Customer-Managed Encryption Keys (CMEK)
  1454. </span>
  1455. </a>
  1456. </li>
  1457. </ul>
  1458. </nav>
  1459. </li>
  1460. <li class="md-nav__item">
  1461. <a href="#regional-secrets" class="md-nav__link">
  1462. <span class="md-ellipsis">
  1463. Regional Secrets
  1464. </span>
  1465. </a>
  1466. </li>
  1467. <li class="md-nav__item">
  1468. <a href="#secret-version-management" class="md-nav__link">
  1469. <span class="md-ellipsis">
  1470. Secret Version Management
  1471. </span>
  1472. </a>
  1473. <nav class="md-nav" aria-label="Secret Version Management">
  1474. <ul class="md-nav__list">
  1475. <li class="md-nav__item">
  1476. <a href="#secret-version-selection-policy" class="md-nav__link">
  1477. <span class="md-ellipsis">
  1478. Secret Version Selection Policy
  1479. </span>
  1480. </a>
  1481. <nav class="md-nav" aria-label="Secret Version Selection Policy">
  1482. <ul class="md-nav__list">
  1483. <li class="md-nav__item">
  1484. <a href="#available-policies" class="md-nav__link">
  1485. <span class="md-ellipsis">
  1486. Available Policies
  1487. </span>
  1488. </a>
  1489. </li>
  1490. <li class="md-nav__item">
  1491. <a href="#configuration-example" class="md-nav__link">
  1492. <span class="md-ellipsis">
  1493. Configuration Example
  1494. </span>
  1495. </a>
  1496. </li>
  1497. </ul>
  1498. </nav>
  1499. </li>
  1500. </ul>
  1501. </nav>
  1502. </li>
  1503. </ul>
  1504. </nav>
  1505. </div>
  1506. </div>
  1507. </div>
  1508. <div class="md-content" data-md-component="content">
  1509. <article class="md-content__inner md-typeset">
  1510. <h1>Google Cloud Secret Manager</h1>
  1511. <p>External Secrets Operator integrates with the <a href="https://cloud.google.com/secret-manager">Google Cloud Secret Manager</a>.</p>
  1512. <h2 id="authentication">Authentication</h2>
  1513. <h3 id="workload-identity-federation">Workload Identity Federation</h3>
  1514. <p>Through <a href="https://cloud.google.com/kubernetes-engine/docs/concepts/workload-identity">Workload Identity Federation</a> (WIF), <a href="https://cloud.google.com/kubernetes-engine">Google Kubernetes Engine</a> (GKE) workloads can authenticate with Google Cloud Platform (GCP) services like Secret Manager without using static, long-lived credentials.</p>
  1515. <p>Authenticating through WIF is the recommended approach when using the External Secrets Operator (ESO) on GKE clusters. ESO supports three options:</p>
  1516. <ul>
  1517. <li><strong>Using a Kubernetes service account as a GCP IAM principal</strong>: The <code>SecretStore</code> (or <code>ClusterSecretStore</code>) references a <a href="https://kubernetes.io/docs/concepts/security/service-accounts">Kubernetes service account</a> that is authorized to access Secret Manager secrets.</li>
  1518. <li><strong>Linking a Kubernetes service account to a GCP service account:</strong> The <code>SecretStore</code> (or <code>ClusterSecretStore</code>) references a Kubernetes service account, which is linked to a <a href="https://cloud.google.com/iam/docs/service-accounts">GCP service account</a> that is authorized to access Secret Manager secrets. This requires that the Kubernetes service account is annotated correctly and granted the <code>iam.workloadIdentityUser</code> role on the GCP service account.</li>
  1519. <li><strong>Authorizing the Core Controller Pod:</strong> The ESO Core Controller Pod's service account is authorized to access Secret Manager secrets. No authentication is required for <code>SecretStore</code> and <code>ClusterSecretStore</code> instances.</li>
  1520. </ul>
  1521. <p>In the following, we will describe each of these options in detail.</p>
  1522. <h4 id="prerequisites">Prerequisites</h4>
  1523. <ul>
  1524. <li>Ensure that <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">Workload Identity Federation is enabled</a> for the GKE cluster.</li>
  1525. </ul>
  1526. <p><em>Note that while Google Cloud WIF <a href="https://cloud.google.com/iam/docs/workload-identity-federation-with-kubernetes">is available for AKS, EKS, and self-hosted Kubernetes clusters</a>, ESO currently supports WIF authentication only for GKE (<a href="https://github.com/external-secrets/external-secrets/issues/1038">Issue #1038</a>).</em></p>
  1527. <h4 id="using-a-kubernetes-service-account-as-a-gcp-iam-principal">Using a Kubernetes service account as a GCP IAM principal</h4>
  1528. <p>The <code>SecretStore</code> (or <code>ClusterSecretStore</code>) references a Kubernetes service account that is authorized to access Secret Manager secrets.</p>
  1529. <p>To demonstrate this approach, we'll create a <code>SecretStore</code> in the <code>demo</code> namespace.</p>
  1530. <p>First, create a Kubernetes service account in the <code>demo</code> namespace:</p>
  1531. <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">v1</span>
  1532. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1533. <span class="nt">metadata</span><span class="p">:</span>
  1534. <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">demo-secrets-sa</span>
  1535. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1536. </code></pre></div>
  1537. <p>To grant a Kubernetes service account access to Secret Manager secret(s), you need to know four values:</p>
  1538. <ul>
  1539. <li><code>PROJECT_ID</code>: Your GCP project ID, which you can find under "Project Info" on your console dashboard. Note that this might be different from your project's <em>name</em>.</li>
  1540. <li><code>PROJECT_NUMBER</code>: Your GCP project number, which you can find under "Project Info" on your console dashboard or through <code>gcloud projects describe $PROJECT_ID --format="value(projectNumber)"</code>.</li>
  1541. <li><code>K8S_SA</code>: The name of the Kubernetes service account you created. (In our example, <code>demo-secrets-sa</code>.)</li>
  1542. <li><code>K8S_NAMESPACE</code>: The namespace where you created the Kubernetes service account (In our example, <code>demo</code>.)</li>
  1543. </ul>
  1544. <p>For example, the following CLI call grants the Kubernetes service account access to a secret <code>demo-secret</code>:</p>
  1545. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>secrets<span class="w"> </span>add-iam-policy-binding<span class="w"> </span>demo-secret<span class="w"> </span><span class="se">\</span>
  1546. <span class="w"> </span>--project<span class="o">=</span><span class="nv">$PROJECT_ID</span><span class="w"> </span><span class="se">\</span>
  1547. <span class="w"> </span>--role<span class="o">=</span><span class="s2">&quot;roles/secretmanager.secretAccessor&quot;</span><span class="w"> </span><span class="se">\</span>
  1548. <span class="w"> </span>--member<span class="o">=</span><span class="s2">&quot;principal://iam.googleapis.com/projects/</span><span class="si">${</span><span class="nv">PROJECT_NUMBER</span><span class="si">}</span><span class="s2">/locations/global/workloadIdentityPools/</span><span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span><span class="s2">.svc.id.goog/subject/ns/</span><span class="si">${</span><span class="nv">K8S_NAMESPACE</span><span class="si">}</span><span class="s2">/sa/</span><span class="si">${</span><span class="nv">K8S_SA</span><span class="si">}</span><span class="s2">&quot;</span>
  1549. </code></pre></div>
  1550. <p>You can also grant the Kubernetes service account access to <em>all</em> secrets in a GCP project:</p>
  1551. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>projects<span class="w"> </span>add-iam-policy-binding<span class="w"> </span><span class="nv">$PROJECT_ID</span><span class="w"> </span><span class="se">\</span>
  1552. <span class="w"> </span>--role<span class="o">=</span><span class="s2">&quot;roles/secretmanager.secretAccessor&quot;</span><span class="w"> </span><span class="se">\</span>
  1553. <span class="w"> </span>--member<span class="o">=</span><span class="s2">&quot;principal://iam.googleapis.com/projects/</span><span class="si">${</span><span class="nv">PROJECT_NUMBER</span><span class="si">}</span><span class="s2">/locations/global/workloadIdentityPools/</span><span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span><span class="s2">.svc.id.goog/subject/ns/</span><span class="si">${</span><span class="nv">K8S_NAMESPACE</span><span class="si">}</span><span class="s2">/sa/</span><span class="si">${</span><span class="nv">K8S_SA</span><span class="si">}</span><span class="s2">&quot;</span>
  1554. </code></pre></div>
  1555. <p>Note that this allows anyone who can create <code>ExternalSecret</code> resources referencing a <code>SecretStore</code> instance using this service account access to all secrets in the project.</p>
  1556. <p><em>For more information about WIF and Secret Manager permissions, refer to:</em></p>
  1557. <ul>
  1558. <li><em><a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">Authenticate to Google Cloud APIs from GKE workloads</a> in the GKE documentation.</em></li>
  1559. <li><em><a href="https://cloud.google.com/secret-manager/docs/access-control">Access control with IAM</a> in the Secret Manager documentation.</em></li>
  1560. </ul>
  1561. <p>Next, create a <code>SecretStore</code> that references the <code>demo-secrets-sa</code> Kubernetes service account:</p>
  1562. <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>
  1563. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1564. <span class="nt">metadata</span><span class="p">:</span>
  1565. <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">demo-store</span>
  1566. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1567. <span class="nt">spec</span><span class="p">:</span>
  1568. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1569. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1570. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span>
  1571. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1572. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span>
  1573. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1574. <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">demo-secrets-sa</span>
  1575. </code></pre></div>
  1576. <p>In the case of a <code>ClusterSecretStore</code>, you additionally have to define the service account's <code>namespace</code> under <code>auth.workloadIdentity.serviceAccountRef</code>.</p>
  1577. <p>Finally, you can create an <code>ExternalSecret</code> for the <code>demo-secret</code> that references this <code>SecretStore</code>:</p>
  1578. <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>
  1579. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1580. <span class="nt">metadata</span><span class="p">:</span>
  1581. <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">demo-external-secret</span>
  1582. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1583. <span class="nt">spec</span><span class="p">:</span>
  1584. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1585. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1586. <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">demo-store</span>
  1587. <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">SecretStore</span>
  1588. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1589. <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">secret-to-be-created</span>
  1590. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span>
  1591. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1592. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DEMO_SECRET</span>
  1593. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1594. <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">demo-secret</span>
  1595. </code></pre></div>
  1596. <h4 id="linking-a-kubernetes-service-account-to-a-gcp-service-account">Linking a Kubernetes service account to a GCP service account</h4>
  1597. <p>The <code>SecretStore</code> (or <code>ClusterSecretStore</code>) references a Kubernetes service account, which is linked to a GCP service account that is authorized to access Secret Manager secrets.</p>
  1598. <p>To demonstrate this approach, we'll create a <code>SecretStore</code> in the <code>demo</code> namespace.</p>
  1599. <p>To set up the Kubernetes service account, you need to know or choose the following values:</p>
  1600. <ul>
  1601. <li><code>PROJECT_ID</code>: Your GCP project ID, which you can find under "Project Info" on your console dashboard. Note that this might be different from your project's <em>name</em>.</li>
  1602. <li><code>GCP_SA</code>: The name of the GCP service account you are going to create and use (e.g., <code>external-secrets</code>).</li>
  1603. </ul>
  1604. <p>First, create the Kubernetes service account with an annotation that references the GCP service account:</p>
  1605. <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">v1</span>
  1606. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1607. <span class="nt">metadata</span><span class="p">:</span>
  1608. <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">demo-secrets-sa</span>
  1609. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1610. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1611. <span class="w"> </span><span class="nt">iam.gke.io/gcp-service-account</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">GCP_SA</span><span class="p p-Indicator">]</span><span class="err">@</span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span><span class="l l-Scalar l-Scalar-Plain">.iam.gserviceaccount.com</span>
  1612. </code></pre></div>
  1613. <p>Next, create the GCP service account:</p>
  1614. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>iam<span class="w"> </span>service-accounts<span class="w"> </span>create<span class="w"> </span><span class="nv">$GCP_SA</span><span class="w"> </span><span class="se">\</span>
  1615. <span class="w"> </span>--project<span class="o">=</span><span class="nv">$PROJECT_ID</span>
  1616. </code></pre></div>
  1617. <p>To finalize the link between the GCP service account and the Kubernetes service account, you need two additional values:</p>
  1618. <ul>
  1619. <li><code>K8S_SA</code>: The name of the Kubernetes service account you created. (In our example, <code>demo-secrets-sa</code>.)</li>
  1620. <li><code>K8S_NAMESPACE</code>: The namespace where you created the Kubernetes service account (In our example, <code>demo</code>.)</li>
  1621. </ul>
  1622. <p>Grant the Kubernetes service account the <code>iam.workloadIdentityUser</code> role on the GCP service account:</p>
  1623. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>iam<span class="w"> </span>service-accounts<span class="w"> </span>add-iam-policy-binding<span class="w"> </span><span class="se">\</span>
  1624. <span class="w"> </span><span class="si">${</span><span class="nv">GCP_SA</span><span class="si">}</span>@<span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span>.iam.gserviceaccount.com<span class="w"> </span><span class="se">\</span>
  1625. <span class="w"> </span>--role<span class="o">=</span><span class="s2">&quot;roles/iam.workloadIdentityUser&quot;</span><span class="w"> </span><span class="se">\</span>
  1626. <span class="w"> </span>--member<span class="w"> </span><span class="s2">&quot;serviceAccount:</span><span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span><span class="s2">.svc.id.goog[</span><span class="si">${</span><span class="nv">K8S_NAMESPACE</span><span class="si">}</span><span class="s2">/</span><span class="si">${</span><span class="nv">K8S_SA</span><span class="si">}</span><span class="s2">]&quot;</span>
  1627. </code></pre></div>
  1628. <p>Next, grant the GCP service account access to a secret in the Secret Manager.
  1629. For example, the following CLI call grants it access to a secret <code>demo-secret</code>:</p>
  1630. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>secrets<span class="w"> </span>add-iam-policy-binding<span class="w"> </span>demo-secret<span class="w"> </span><span class="se">\</span>
  1631. <span class="w"> </span>--project<span class="o">=</span><span class="nv">$PROJECT_ID</span><span class="w"> </span><span class="se">\</span>
  1632. <span class="w"> </span>--role<span class="o">=</span><span class="s2">&quot;roles/secretmanager.secretAccessor&quot;</span>
  1633. <span class="w"> </span>--member<span class="w"> </span><span class="s2">&quot;serviceAccount:</span><span class="si">${</span><span class="nv">GCP_SA</span><span class="si">}</span><span class="s2">@</span><span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span><span class="s2">.iam.gserviceaccount.com&quot;</span>
  1634. </code></pre></div>
  1635. <p>You can also grant the GCP service account access to <em>all</em> secrets in a GCP project:</p>
  1636. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>project<span class="w"> </span>add-iam-policy-binding<span class="w"> </span><span class="nv">$PROJECT_ID</span><span class="w"> </span><span class="se">\</span>
  1637. <span class="w"> </span>--role<span class="o">=</span><span class="s2">&quot;roles/secretmanager.secretAccessor&quot;</span>
  1638. <span class="w"> </span>--member<span class="w"> </span><span class="s2">&quot;serviceAccount:</span><span class="si">${</span><span class="nv">GCP_SA</span><span class="si">}</span><span class="s2">@</span><span class="si">${</span><span class="nv">PROJECT_ID</span><span class="si">}</span><span class="s2">.iam.gserviceaccount.com&quot;</span>
  1639. </code></pre></div>
  1640. <p>Note that this allows anyone who can create <code>ExternalSecret</code> resources referencing a <code>SecretStore</code> instance using this service account access to all secrets in the project.</p>
  1641. <p><em>For more information about WIF and Secret Manager permissions, refer to:</em></p>
  1642. <ul>
  1643. <li><em><a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">Authenticate to Google Cloud APIs from GKE workloads</a> in the GKE documentation.</em></li>
  1644. <li><em><a href="https://cloud.google.com/secret-manager/docs/access-control">Access control with IAM</a> in the Secret Manager documentation.</em></li>
  1645. </ul>
  1646. <p>Next, create a <code>SecretStore</code> that references the <code>demo-secrets-sa</code> Kubernetes service account:</p>
  1647. <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>
  1648. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1649. <span class="nt">metadata</span><span class="p">:</span>
  1650. <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">demo-store</span>
  1651. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1652. <span class="nt">spec</span><span class="p">:</span>
  1653. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1654. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1655. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span>
  1656. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1657. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span>
  1658. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1659. <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">demo-secrets-sa</span>
  1660. </code></pre></div>
  1661. <p>In the case of a <code>ClusterSecretStore</code>, you additionally have to define the service account's <code>namespace</code> under <code>auth.workloadIdentity.serviceAccountRef</code>.</p>
  1662. <p>Finally, you can create an <code>ExternalSecret</code> for the <code>demo-secret</code> that references this <code>SecretStore</code>:</p>
  1663. <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>
  1664. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1665. <span class="nt">metadata</span><span class="p">:</span>
  1666. <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">demo-external-secret</span>
  1667. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1668. <span class="nt">spec</span><span class="p">:</span>
  1669. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1670. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1671. <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">demo-store</span>
  1672. <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">SecretStore</span>
  1673. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1674. <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">secret-to-be-created</span>
  1675. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span>
  1676. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1677. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DEMO_SECRET</span>
  1678. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1679. <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">demo-secret</span>
  1680. </code></pre></div>
  1681. <h4 id="authorizing-the-core-controller-pod">Authorizing the Core Controller Pod</h4>
  1682. <p>Instead of managing authentication at the <code>SecretStore</code> and <code>ClusterSecretStore</code> level, you can give the <a href="../../api/components/">Core Controller</a> Pod's service account access to Secret Manager secrets using one of the two WIF approaches described in the previous sections.</p>
  1683. <p>To demonstrate this approach, we'll assume you installed ESO using Helm into the <code>external-secrets</code> namespace, with <code>external-secrets</code> as the release name:</p>
  1684. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>external-secrets<span class="w"> </span>https://charts.external-secrets.io
  1685. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets<span class="w"> </span><span class="se">\</span>
  1686. <span class="w"> </span>--namespace<span class="w"> </span>external-secrets<span class="w"> </span>--create-namespace
  1687. </code></pre></div>
  1688. <p>This creates a Kubernetes service account <code>external-secrets</code> in the <code>external-secrets</code> namespace, which is used by the Core Controller Pod.</p>
  1689. <p>To verify this (or to determine the service account's name in a different setup), you can run:</p>
  1690. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pods<span class="w"> </span>--namespace<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1691. <span class="w"> </span>--selector<span class="w"> </span>app.kubernetes.io/name<span class="o">=</span>external-secrets<span class="w"> </span><span class="se">\</span>
  1692. <span class="w"> </span>--output<span class="w"> </span><span class="nv">jsonpath</span><span class="o">=</span><span class="s1">&#39;{.items[0].spec.serviceAccountName}&#39;</span>
  1693. </code></pre></div>
  1694. <p>Use WIF to grant this Kubernetes service account access to the Secret Manager secrets.
  1695. You can use either of the approaches described in the previous two sections.</p>
  1696. <p><em>For details and further information on WIF and Secret Manager permissions, refer to:</em></p>
  1697. <ul>
  1698. <li><em><a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">Authenticate to Google Cloud APIs from GKE workloads</a> in the GKE documentation.</em></li>
  1699. <li><em><a href="https://cloud.google.com/secret-manager/docs/access-control">Access control with IAM</a> in the Secret Manager documentation.</em></li>
  1700. </ul>
  1701. <p>Once the Core Controller Pod can access the Secret Manager secret(s) through WIF via its Kubernetes service account, you can create <code>SecretStore</code> or <code>ClusterSecretStore</code> instances that only specify the GCP project ID, omitting the <code>auth</code> section entirely:</p>
  1702. <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>
  1703. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1704. <span class="nt">metadata</span><span class="p">:</span>
  1705. <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">demo-store</span>
  1706. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1707. <span class="nt">spec</span><span class="p">:</span>
  1708. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1709. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1710. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span>
  1711. </code></pre></div>
  1712. <h4 id="explicitly-specifying-the-gke-clusters-name-and-location">Explicitly specifying the GKE cluster's name and location</h4>
  1713. <p>When creating a <code>SecretStore</code> or <code>ClusterSecretStore</code> that uses WIF, the GKE cluster's project ID, name, and location are automatically determined through the <a href="https://cloud.google.com/compute/docs/metadata/overview">GCP metadata server</a>.
  1714. Alternatively, you can explicitly specify some or all of these values.</p>
  1715. <p>For a fully specified configuration, you'll need to know the following three values:</p>
  1716. <ul>
  1717. <li><code>CLUSTER_PROJECT_ID</code>: The ID of GCP project that contains the GKE cluster.</li>
  1718. <li><code>CLUSTER_NAME</code>: The name of the GKE cluster.</li>
  1719. <li><code>CLUSTER_LOCATION</code>: The location of the GKE cluster. For a regional cluster, this is the region. For a zonal cluster, this is the zone.</li>
  1720. </ul>
  1721. <p>You can optionally verify these values through the CLI:</p>
  1722. <div class="highlight"><pre><span></span><code>gcloud<span class="w"> </span>container<span class="w"> </span>clusters<span class="w"> </span>describe<span class="w"> </span><span class="nv">$CLUSTER_NAME</span><span class="w"> </span><span class="se">\</span>
  1723. <span class="w"> </span>--project<span class="o">=</span><span class="nv">$CLUSTER_PROJECT_ID</span><span class="w"> </span>--location<span class="o">=</span><span class="nv">$CLUSTER_LOCATION</span>
  1724. </code></pre></div>
  1725. <p>If the three values are correct, this returns information about your GKE cluster.</p>
  1726. <p>Then, you can create a <code>SecretStore</code> or <code>ClusterSecretStore</code> that explicitly specifies the cluster's project ID, name, and location:</p>
  1727. <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>
  1728. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1729. <span class="nt">metadata</span><span class="p">:</span>
  1730. <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">demo-store</span>
  1731. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1732. <span class="nt">spec</span><span class="p">:</span>
  1733. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1734. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1735. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span>
  1736. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1737. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span>
  1738. <span class="w"> </span><span class="nt">clusterProjectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">CLUSTER_PROJECT_ID</span><span class="p p-Indicator">]</span>
  1739. <span class="w"> </span><span class="nt">clusterLocation</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">CLUSTER_LOCATION</span><span class="p p-Indicator">]</span>
  1740. <span class="w"> </span><span class="nt">clusterName</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">CLUSTER_NAME</span><span class="p p-Indicator">]</span>
  1741. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1742. <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">demo-secrets-sa</span>
  1743. </code></pre></div>
  1744. <h3 id="authenticating-with-a-gcp-service-account">Authenticating with a GCP service account</h3>
  1745. <p>The <code>SecretStore</code> (or <code>ClusterSecretStore</code>) uses a long-lived, static <a href="https://cloud.google.com/iam/docs/service-account-creds#key-types">GCP service account key</a> to authenticate with GCP.
  1746. This approach can be used on any Kubernetes cluster.</p>
  1747. <p>To demonstrate this approach, we'll create a <code>SecretStore</code> in the <code>demo</code> namespace.</p>
  1748. <p>First, create a GCP service account and grant it the <code>secretmanager.secretAccessor</code> role on the Secret Manager secret(s) you want to access.</p>
  1749. <p><em>For details and further information on managing service account permissions and Secret Manager roles, refer to:</em></p>
  1750. <ul>
  1751. <li><em><a href="https://cloud.google.com/iam/docs/attach-service-accounts">Attach service accounts to resources</a> in the IAM documentation.</em></li>
  1752. <li><em><a href="https://cloud.google.com/secret-manager/docs/access-control">Access control with IAM</a> in the Secret Manager documentation.</em></li>
  1753. </ul>
  1754. <p>Then, create a service account key pair using one of the methods described on the page <a href="https://cloud.google.com/iam/docs/keys-create-delete">Create and delete service account keys</a> in the Google Cloud IAM documentation and store the JSON file with the private key in a Kubernetes <code>Secret</code>:</p>
  1755. <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">v1</span>
  1756. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1757. <span class="nt">metadata</span><span class="p">:</span>
  1758. <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">gcp-sa-secret</span>
  1759. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1760. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  1761. <span class="nt">stringData</span><span class="p">:</span>
  1762. <span class="w"> </span><span class="nt">secret-access-credentials</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|-</span>
  1763. <span class="w"> </span><span class="no">{</span>
  1764. <span class="w"> </span><span class="no">&quot;type&quot;: &quot;service_account&quot;,</span>
  1765. <span class="w"> </span><span class="no">&quot;project_id&quot;: &quot;external-secrets-operator&quot;,</span>
  1766. <span class="w"> </span><span class="no">&quot;private_key_id&quot;: &quot;&quot;,</span>
  1767. <span class="w"> </span><span class="no">&quot;private_key&quot;: &quot;-----BEGIN PRIVATE KEY-----\nA key\n-----END PRIVATE KEY-----\n&quot;,</span>
  1768. <span class="w"> </span><span class="no">&quot;client_email&quot;: &quot;test-service-account@external-secrets-operator.iam.gserviceaccount.com&quot;,</span>
  1769. <span class="w"> </span><span class="no">&quot;client_id&quot;: &quot;client ID&quot;,</span>
  1770. <span class="w"> </span><span class="no">&quot;auth_uri&quot;: &quot;https://accounts.google.com/o/oauth2/auth&quot;,</span>
  1771. <span class="w"> </span><span class="no">&quot;token_uri&quot;: &quot;https://oauth2.googleapis.com/token&quot;,</span>
  1772. <span class="w"> </span><span class="no">&quot;auth_provider_x509_cert_url&quot;: &quot;https://www.googleapis.com/oauth2/v1/certs&quot;,</span>
  1773. <span class="w"> </span><span class="no">&quot;client_x509_cert_url&quot;: &quot;https://www.googleapis.com/robot/v1/metadata/x509/test-service-account%40external-secrets-operator.iam.gserviceaccount.com&quot;</span>
  1774. <span class="w"> </span><span class="no">}</span>
  1775. </code></pre></div>
  1776. <p>Finally, reference this secret in the <code>SecretStore</code> manifest:</p>
  1777. <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>
  1778. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1779. <span class="nt">metadata</span><span class="p">:</span>
  1780. <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">demo-store</span>
  1781. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
  1782. <span class="nt">spec</span><span class="p">:</span>
  1783. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1784. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1785. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1786. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1787. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1788. <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">gcp-sa-secret</span>
  1789. <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">secret-access-credentials</span>
  1790. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">PROJECT_ID</span><span class="p p-Indicator">]</span>
  1791. </code></pre></div>
  1792. <p>In the case of a <code>ClusterSecretStore</code>, you additionally have to specify the service account's <code>namespace</code> under <code>auth.secretRef.secretAccessKeySecretRef</code>.</p>
  1793. <h2 id="using-pushsecret-with-an-existing-google-secret-manager-secret">Using PushSecret with an existing Google Secret Manager secret</h2>
  1794. <p>There are some use cases where you want to use PushSecret for an existing Google Secret Manager Secret that already has labels defined. For example when the creation of the secret is managed by another controller like Kubernetes Config Connector (KCC) and the updating of the secret is managed by ESO.</p>
  1795. <p>To allow ESO to take ownership of the existing Google Secret Manager Secret, you need to add the label <code>"managed-by": "external-secrets"</code>.</p>
  1796. <p>By default, the PushSecret spec will replace any existing labels on the existing GCP Secret Manager Secret. To prevent this, a new field was added to the <code>spec.data.metadata</code> object called <code>mergePolicy</code> which defaults to <code>Replace</code> to ensure that there are no breaking changes and is backward compatible. The other option for this field is <code>Merge</code> which will merge the existing labels on the Google Secret Manager Secret with the labels defined in the PushSecret spec. This ensures that the existing labels defined on the Google Secret Manager Secret are retained.</p>
  1797. <p>Example of using the <code>mergePolicy</code> field:</p>
  1798. <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/v1alpha1</span>
  1799. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1800. <span class="nt">metadata</span><span class="p">:</span>
  1801. <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">pushsecret-example</span>
  1802. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  1803. <span class="nt">spec</span><span class="p">:</span>
  1804. <span class="w"> </span><span class="nt">updatePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Replace</span>
  1805. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span>
  1806. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1807. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1808. <span class="w"> </span><span class="p p-Indicator">-</span><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">gcp-secretstore</span>
  1809. <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">SecretStore</span>
  1810. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1811. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1812. <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">bestpokemon</span>
  1813. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1814. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1815. <span class="w"> </span><span class="nt">bestpokemon</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.bestpokemon</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1816. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1817. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span>
  1818. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1819. <span class="w"> </span><span class="nt">mergePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Merge</span>
  1820. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1821. <span class="w"> </span><span class="nt">anotherLabel</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">anotherValue</span>
  1822. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1823. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bestpokemon</span>
  1824. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1825. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">best-pokemon</span>
  1826. </code></pre></div>
  1827. <h2 id="secret-replication-and-encryption-configuration">Secret Replication and Encryption Configuration</h2>
  1828. <h3 id="location-and-replication">Location and Replication</h3>
  1829. <p>By default, secrets are automatically replicated across multiple regions. You can specify a single location for your secrets by setting the <code>replicationLocation</code> field:</p>
  1830. <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/v1alpha1</span>
  1831. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1832. <span class="nt">metadata</span><span class="p">:</span>
  1833. <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">pushsecret-example</span>
  1834. <span class="nt">spec</span><span class="p">:</span>
  1835. <span class="w"> </span><span class="c1"># ... other fields ...</span>
  1836. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1837. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1838. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mykey</span>
  1839. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1840. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-secret</span>
  1841. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1842. <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">kubernetes.external-secrets.io/v1alpha1</span>
  1843. <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">PushSecretMetadata`</span>
  1844. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1845. <span class="w"> </span><span class="nt">replicationLocation</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;us-east1&quot;</span>
  1846. </code></pre></div>
  1847. <h3 id="customer-managed-encryption-keys-cmek">Customer-Managed Encryption Keys (CMEK)</h3>
  1848. <p>You can use your own encryption keys to encrypt secrets at rest. To use Customer-Managed Encryption Keys (CMEK), you need to:</p>
  1849. <ol>
  1850. <li>Create a Cloud KMS key</li>
  1851. <li>Grant the service account the <code>roles/cloudkms.cryptoKeyEncrypterDecrypter</code> role on the key</li>
  1852. <li>Specify the key in the PushSecret metadata</li>
  1853. </ol>
  1854. <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/v1alpha1</span>
  1855. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1856. <span class="nt">metadata</span><span class="p">:</span>
  1857. <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">pushsecret-example</span>
  1858. <span class="nt">spec</span><span class="p">:</span>
  1859. <span class="w"> </span><span class="c1"># ... other fields ...</span>
  1860. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1861. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1862. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mykey</span>
  1863. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1864. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-secret</span>
  1865. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1866. <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">kubernetes.external-secrets.io/v1alpha1</span>
  1867. <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">PushSecretMetadata</span>
  1868. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1869. <span class="w"> </span><span class="nt">cmekKeyName</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;projects/my-project/locations/us-east1/keyRings/my-keyring/cryptoKeys/my-key&quot;</span>
  1870. </code></pre></div>
  1871. <p>Note: When using CMEK, you must specify a location in the SecretStore as customer-managed encryption keys are region-specific.</p>
  1872. <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>
  1873. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1874. <span class="nt">metadata</span><span class="p">:</span>
  1875. <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">gcp-secret-store</span>
  1876. <span class="nt">spec</span><span class="p">:</span>
  1877. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1878. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1879. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-project</span>
  1880. <span class="w"> </span><span class="nt">location</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east1</span><span class="w"> </span><span class="c1"># Required when using CMEK</span>
  1881. </code></pre></div>
  1882. <h2 id="regional-secrets">Regional Secrets</h2>
  1883. <p>GCP Secret Manager Regional Secrets are available to be used with both ExternalSecrets and PushSecrets.</p>
  1884. <p>In order to achieve so, add a <code>location</code> to your SecretStore definition:</p>
  1885. <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/v1beta1</span>
  1886. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1887. <span class="nt">metadata</span><span class="p">:</span>
  1888. <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">gcp-secret-store</span>
  1889. <span class="nt">spec</span><span class="p">:</span>
  1890. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1891. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1892. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-project</span>
  1893. <span class="w"> </span><span class="nt">location</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east1</span><span class="w"> </span><span class="c1"># uses regional secrets on us-east1</span>
  1894. </code></pre></div>
  1895. <h2 id="secret-version-management">Secret Version Management</h2>
  1896. <h3 id="secret-version-selection-policy">Secret Version Selection Policy</h3>
  1897. <p>The Google Secret Manager provider includes a <code>secretVersionSelectionPolicy</code> field that controls how the provider handles secret version selection when the default "latest" version is unavailable.</p>
  1898. <p>By default, when you request a secret without specifying a version, the provider attempts to fetch the "latest" version. The <code>secretVersionSelectionPolicy</code> determines what happens if that version is in a DESTROYED or DISABLED state.</p>
  1899. <h4 id="available-policies">Available Policies</h4>
  1900. <ul>
  1901. <li><strong><code>LatestOrFail</code></strong> (default): The provider always uses "latest", or fails if that version is disabled/destroyed.</li>
  1902. <li><strong><code>LatestOrFetch</code></strong>: The provider falls back to fetching the latest enabled version if the "latest" version is DESTROYED or DISABLED.</li>
  1903. </ul>
  1904. <h4 id="configuration-example">Configuration Example</h4>
  1905. <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/v1beta1</span>
  1906. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1907. <span class="nt">metadata</span><span class="p">:</span>
  1908. <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">gcp-secret-store</span>
  1909. <span class="nt">spec</span><span class="p">:</span>
  1910. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1911. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1912. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-project</span>
  1913. <span class="w"> </span><span class="nt">location</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east1</span>
  1914. <span class="w"> </span><span class="nt">secretVersionSelectionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">LatestOrFetch</span><span class="w"> </span><span class="c1"># or LatestOrFail (default)</span>
  1915. </code></pre></div>
  1916. <p><strong>Note</strong>: When using <code>secretVersionSelectionPolicy: LatestOrFetch</code>, the service account requires additional permissions to list secret versions. You'll need to grant the <code>roles/secretmanager.viewer</code> role (which includes <code>secretmanager.versions.list</code>) or the specific <code>secretmanager.versions.list</code> permission in addition to the standard <code>secretmanager.secretAccessor</code> role.</p>
  1917. <p>```</p>
  1918. </article>
  1919. </div>
  1920. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1921. </div>
  1922. </main>
  1923. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1924. <footer class="md-footer">
  1925. <div class="md-footer-meta md-typeset">
  1926. <div class="md-footer-meta__inner md-grid">
  1927. <div class="md-copyright">
  1928. <div class="md-copyright__highlight">
  1929. &copy; 2025 The external-secrets Authors.<br/>
  1930. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1931. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1932. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1933. </div>
  1934. Made with
  1935. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1936. Material for MkDocs
  1937. </a>
  1938. </div>
  1939. </div>
  1940. </div>
  1941. </footer>
  1942. </div>
  1943. <div class="md-dialog" data-md-component="dialog">
  1944. <div class="md-dialog__inner md-typeset"></div>
  1945. </div>
  1946. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.973d3a69.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>
  1947. <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
  1948. </body>
  1949. </html>