index.html 99 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035
  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.5.49">
  10. <title>Google Cloud Secret Manager - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.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="#google-cloud-secret-manager" 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]"),outdated=__md_get("__outdated",sessionStorage);!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 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  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 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/sts/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. AWS STS Session Token
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/cluster/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Cluster Generator
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/gcr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Google Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/quay/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Quay
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/vault/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Vault Dynamic Secret
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/password/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Password
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/fake/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Fake
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/webhook/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Webhook
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/github/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Github
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/uuid/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. UUID
  405. </span>
  406. </a>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  413. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  414. <span class="md-ellipsis">
  415. Reference Docs
  416. </span>
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  420. <label class="md-nav__title" for="__nav_2_4">
  421. <span class="md-nav__icon md-icon"></span>
  422. Reference Docs
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../../api/spec/" class="md-nav__link">
  427. <span class="md-ellipsis">
  428. API specification
  429. </span>
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../../api/controller-options/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Controller Options
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item">
  440. <a href="../../api/metrics/" class="md-nav__link">
  441. <span class="md-ellipsis">
  442. Metrics
  443. </span>
  444. </a>
  445. </li>
  446. </ul>
  447. </nav>
  448. </li>
  449. </ul>
  450. </nav>
  451. </li>
  452. <li class="md-nav__item md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  454. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  455. <span class="md-ellipsis">
  456. Guides
  457. </span>
  458. <span class="md-nav__icon md-icon"></span>
  459. </label>
  460. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  461. <label class="md-nav__title" for="__nav_3">
  462. <span class="md-nav__icon md-icon"></span>
  463. Guides
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../../guides/introduction/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Introduction
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item md-nav__item--nested">
  474. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  475. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  476. <span class="md-ellipsis">
  477. External Secrets
  478. </span>
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  482. <label class="md-nav__title" for="__nav_3_2">
  483. <span class="md-nav__icon md-icon"></span>
  484. External Secrets
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Extract structured data
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item">
  495. <a href="../../guides/getallsecrets/" class="md-nav__link">
  496. <span class="md-ellipsis">
  497. Find Secrets by Name or Metadata
  498. </span>
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. Rewriting Keys
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  510. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  511. <span class="md-ellipsis">
  512. Advanced Templating
  513. </span>
  514. <span class="md-nav__icon md-icon"></span>
  515. </label>
  516. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  517. <label class="md-nav__title" for="__nav_3_2_4">
  518. <span class="md-nav__icon md-icon"></span>
  519. Advanced Templating
  520. </label>
  521. <ul class="md-nav__list" data-md-scrollfix>
  522. <li class="md-nav__item">
  523. <a href="../../guides/templating/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. v2
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/templating-v1/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. v1
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Kubernetes Secret Types
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Lifecycle: ownership & deletion
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  555. <span class="md-ellipsis">
  556. Decoding Strategies
  557. </span>
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../guides/controller-class/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Controller Classes
  564. </span>
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../guides/generator/" class="md-nav__link">
  572. <span class="md-ellipsis">
  573. Generators
  574. </span>
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../../guides/pushsecrets/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Push Secrets
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item md-nav__item--nested">
  585. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  586. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  587. <span class="md-ellipsis">
  588. Operations
  589. </span>
  590. <span class="md-nav__icon md-icon"></span>
  591. </label>
  592. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  593. <label class="md-nav__title" for="__nav_3_5">
  594. <span class="md-nav__icon md-icon"></span>
  595. Operations
  596. </label>
  597. <ul class="md-nav__list" data-md-scrollfix>
  598. <li class="md-nav__item">
  599. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Multi Tenancy
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/security-best-practices/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Security Best Practices
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/threat-model/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Threat Model
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/v1beta1/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Upgrading to v1beta1
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/using-latest-image/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Using Latest Image
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Disable Cluster Features
  637. </span>
  638. </a>
  639. </li>
  640. </ul>
  641. </nav>
  642. </li>
  643. </ul>
  644. </nav>
  645. </li>
  646. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  647. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  648. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  649. <span class="md-ellipsis">
  650. Provider
  651. </span>
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  655. <label class="md-nav__title" for="__nav_4">
  656. <span class="md-nav__icon md-icon"></span>
  657. Provider
  658. </label>
  659. <ul class="md-nav__list" data-md-scrollfix>
  660. <li class="md-nav__item">
  661. <a href="../aws-secrets-manager/" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. AWS Secrets Manager
  664. </span>
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../aws-parameter-store/" class="md-nav__link">
  669. <span class="md-ellipsis">
  670. AWS Parameter Store
  671. </span>
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../azure-key-vault/" class="md-nav__link">
  676. <span class="md-ellipsis">
  677. Azure Key Vault
  678. </span>
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../beyondtrust/" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. BeyondTrust
  685. </span>
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  690. <span class="md-ellipsis">
  691. Bitwarden Secrets Manager
  692. </span>
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../chef/" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Chef
  699. </span>
  700. </a>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="../conjur/" class="md-nav__link">
  704. <span class="md-ellipsis">
  705. CyberArk Conjur
  706. </span>
  707. </a>
  708. </li>
  709. <li class="md-nav__item">
  710. <a href="../device42/" class="md-nav__link">
  711. <span class="md-ellipsis">
  712. Device42
  713. </span>
  714. </a>
  715. </li>
  716. <li class="md-nav__item md-nav__item--active">
  717. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  718. <label class="md-nav__link md-nav__link--active" for="__toc">
  719. <span class="md-ellipsis">
  720. Google Cloud Secret Manager
  721. </span>
  722. <span class="md-nav__icon md-icon"></span>
  723. </label>
  724. <a href="./" class="md-nav__link md-nav__link--active">
  725. <span class="md-ellipsis">
  726. Google Cloud Secret Manager
  727. </span>
  728. </a>
  729. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  730. <label class="md-nav__title" for="__toc">
  731. <span class="md-nav__icon md-icon"></span>
  732. Table of contents
  733. </label>
  734. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  735. <li class="md-nav__item">
  736. <a href="#google-cloud-secret-manager" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. Google Cloud Secret Manager
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="#authentication" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. Authentication
  746. </span>
  747. </a>
  748. <nav class="md-nav" aria-label="Authentication">
  749. <ul class="md-nav__list">
  750. <li class="md-nav__item">
  751. <a href="#workload-identity" class="md-nav__link">
  752. <span class="md-ellipsis">
  753. Workload Identity
  754. </span>
  755. </a>
  756. <nav class="md-nav" aria-label="Workload Identity">
  757. <ul class="md-nav__list">
  758. <li class="md-nav__item">
  759. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  760. <span class="md-ellipsis">
  761. Creating Workload Identity Service Accounts
  762. </span>
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="#using-service-accounts-directly" class="md-nav__link">
  767. <span class="md-ellipsis">
  768. Using Service Accounts directly
  769. </span>
  770. </a>
  771. </li>
  772. <li class="md-nav__item">
  773. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  774. <span class="md-ellipsis">
  775. Using Pod-based Workload Identity
  776. </span>
  777. </a>
  778. </li>
  779. </ul>
  780. </nav>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="#gcp-service-account-authentication" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. GCP Service Account authentication
  786. </span>
  787. </a>
  788. <nav class="md-nav" aria-label="GCP Service Account authentication">
  789. <ul class="md-nav__list">
  790. <li class="md-nav__item">
  791. <a href="#update-secret-store" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Update secret store
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="#creating-external-secret" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Creating external secret
  801. </span>
  802. </a>
  803. </li>
  804. </ul>
  805. </nav>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="#pushsecret-owning-an-existing-google-secret-manager-secret" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. PushSecret owning an existing Google Secret Manager Secret
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="#secret-replication-and-encryption-configuration" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. Secret Replication and Encryption Configuration
  818. </span>
  819. </a>
  820. <nav class="md-nav" aria-label="Secret Replication and Encryption Configuration">
  821. <ul class="md-nav__list">
  822. <li class="md-nav__item">
  823. <a href="#location-and-replication" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Location and Replication
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="#customer-managed-encryption-keys-cmek" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. Customer-Managed Encryption Keys (CMEK)
  833. </span>
  834. </a>
  835. </li>
  836. </ul>
  837. </nav>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="#migration-guide-pushsecret-metadata-format-v011x-to-v0120" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. Migration Guide: PushSecret Metadata Format (v0.11.x to v0.12.0)
  843. </span>
  844. </a>
  845. <nav class="md-nav" aria-label="Migration Guide: PushSecret Metadata Format (v0.11.x to v0.12.0)">
  846. <ul class="md-nav__list">
  847. <li class="md-nav__item">
  848. <a href="#old-format-v011x" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Old Format (v0.11.x)
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="#new-format-v0120" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. New Format (v0.12.0+)
  858. </span>
  859. </a>
  860. </li>
  861. </ul>
  862. </nav>
  863. </li>
  864. </ul>
  865. </nav>
  866. </li>
  867. </ul>
  868. </nav>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../hashicorp-vault/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. HashiCorp Vault
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../kubernetes/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Kubernetes
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../ibm-secrets-manager/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. IBM Secrets Manager
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../akeyless/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Akeyless
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../yandex-certificate-manager/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Yandex Certificate Manager
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../yandex-lockbox/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Yandex Lockbox
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../alibaba/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. Alibaba Cloud
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../gitlab-variables/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. GitLab Variables
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../oracle-vault/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Oracle Vault
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../1password-automation/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. 1Password Secrets Automation
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../webhook/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. Webhook
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../fake/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. Fake
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../senhasegura-dsm/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. senhasegura DevOps Secrets Management (DSM)
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../doppler/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Doppler
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../keeper-security/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. Keeper Security
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../cloak/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Cloak End 2 End Encrypted Secrets
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../scaleway/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Scaleway
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../delinea/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Delinea
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../secretserver/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Secret Server
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../passbolt/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Passbolt
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../pulumi/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Pulumi ESC
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../onboardbase/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Onboardbase
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../provider-passworddepot/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Password Depot
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../fortanix/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Fortanix
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../infisical/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Infisical
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../previder/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Previder
  1049. </span>
  1050. </a>
  1051. </li>
  1052. </ul>
  1053. </nav>
  1054. </li>
  1055. <li class="md-nav__item md-nav__item--nested">
  1056. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1057. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1058. <span class="md-ellipsis">
  1059. Examples
  1060. </span>
  1061. <span class="md-nav__icon md-icon"></span>
  1062. </label>
  1063. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1064. <label class="md-nav__title" for="__nav_5">
  1065. <span class="md-nav__icon md-icon"></span>
  1066. Examples
  1067. </label>
  1068. <ul class="md-nav__list" data-md-scrollfix>
  1069. <li class="md-nav__item">
  1070. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. FluxCD
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Anchore Engine
  1080. </span>
  1081. </a>
  1082. </li>
  1083. <li class="md-nav__item">
  1084. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1085. <span class="md-ellipsis">
  1086. Jenkins
  1087. </span>
  1088. </a>
  1089. </li>
  1090. <li class="md-nav__item">
  1091. <a href="../../examples/bitwarden/" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. BitWarden
  1094. </span>
  1095. </a>
  1096. </li>
  1097. </ul>
  1098. </nav>
  1099. </li>
  1100. <li class="md-nav__item md-nav__item--nested">
  1101. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1102. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1103. <span class="md-ellipsis">
  1104. Community
  1105. </span>
  1106. <span class="md-nav__icon md-icon"></span>
  1107. </label>
  1108. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1109. <label class="md-nav__title" for="__nav_6">
  1110. <span class="md-nav__icon md-icon"></span>
  1111. Community
  1112. </label>
  1113. <ul class="md-nav__list" data-md-scrollfix>
  1114. <li class="md-nav__item md-nav__item--nested">
  1115. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1116. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1117. <span class="md-ellipsis">
  1118. Contributing
  1119. </span>
  1120. <span class="md-nav__icon md-icon"></span>
  1121. </label>
  1122. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1123. <label class="md-nav__title" for="__nav_6_1">
  1124. <span class="md-nav__icon md-icon"></span>
  1125. Contributing
  1126. </label>
  1127. <ul class="md-nav__list" data-md-scrollfix>
  1128. <li class="md-nav__item">
  1129. <a href="../../contributing/devguide/" class="md-nav__link">
  1130. <span class="md-ellipsis">
  1131. Developer guide
  1132. </span>
  1133. </a>
  1134. </li>
  1135. <li class="md-nav__item">
  1136. <a href="../../contributing/process/" class="md-nav__link">
  1137. <span class="md-ellipsis">
  1138. Contributing Process
  1139. </span>
  1140. </a>
  1141. </li>
  1142. <li class="md-nav__item">
  1143. <a href="../../contributing/release/" class="md-nav__link">
  1144. <span class="md-ellipsis">
  1145. Release Process
  1146. </span>
  1147. </a>
  1148. </li>
  1149. <li class="md-nav__item">
  1150. <a href="../../contributing/coc/" class="md-nav__link">
  1151. <span class="md-ellipsis">
  1152. Code of Conduct
  1153. </span>
  1154. </a>
  1155. </li>
  1156. <li class="md-nav__item">
  1157. <a href="../../contributing/roadmap/" class="md-nav__link">
  1158. <span class="md-ellipsis">
  1159. Roadmap
  1160. </span>
  1161. </a>
  1162. </li>
  1163. </ul>
  1164. </nav>
  1165. </li>
  1166. <li class="md-nav__item md-nav__item--nested">
  1167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1168. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1169. <span class="md-ellipsis">
  1170. External Resources
  1171. </span>
  1172. <span class="md-nav__icon md-icon"></span>
  1173. </label>
  1174. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1175. <label class="md-nav__title" for="__nav_6_2">
  1176. <span class="md-nav__icon md-icon"></span>
  1177. External Resources
  1178. </label>
  1179. <ul class="md-nav__list" data-md-scrollfix>
  1180. <li class="md-nav__item">
  1181. <a href="../../eso-talks/" class="md-nav__link">
  1182. <span class="md-ellipsis">
  1183. Talks
  1184. </span>
  1185. </a>
  1186. </li>
  1187. <li class="md-nav__item">
  1188. <a href="../../eso-demos/" class="md-nav__link">
  1189. <span class="md-ellipsis">
  1190. Demos
  1191. </span>
  1192. </a>
  1193. </li>
  1194. <li class="md-nav__item">
  1195. <a href="../../eso-blogs/" class="md-nav__link">
  1196. <span class="md-ellipsis">
  1197. Blogs
  1198. </span>
  1199. </a>
  1200. </li>
  1201. <li class="md-nav__item">
  1202. <a href="../../eso-tools/" class="md-nav__link">
  1203. <span class="md-ellipsis">
  1204. Tools
  1205. </span>
  1206. </a>
  1207. </li>
  1208. </ul>
  1209. </nav>
  1210. </li>
  1211. </ul>
  1212. </nav>
  1213. </li>
  1214. </ul>
  1215. </nav>
  1216. </div>
  1217. </div>
  1218. </div>
  1219. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1220. <div class="md-sidebar__scrollwrap">
  1221. <div class="md-sidebar__inner">
  1222. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1223. <label class="md-nav__title" for="__toc">
  1224. <span class="md-nav__icon md-icon"></span>
  1225. Table of contents
  1226. </label>
  1227. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1228. <li class="md-nav__item">
  1229. <a href="#google-cloud-secret-manager" class="md-nav__link">
  1230. <span class="md-ellipsis">
  1231. Google Cloud Secret Manager
  1232. </span>
  1233. </a>
  1234. </li>
  1235. <li class="md-nav__item">
  1236. <a href="#authentication" class="md-nav__link">
  1237. <span class="md-ellipsis">
  1238. Authentication
  1239. </span>
  1240. </a>
  1241. <nav class="md-nav" aria-label="Authentication">
  1242. <ul class="md-nav__list">
  1243. <li class="md-nav__item">
  1244. <a href="#workload-identity" class="md-nav__link">
  1245. <span class="md-ellipsis">
  1246. Workload Identity
  1247. </span>
  1248. </a>
  1249. <nav class="md-nav" aria-label="Workload Identity">
  1250. <ul class="md-nav__list">
  1251. <li class="md-nav__item">
  1252. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  1253. <span class="md-ellipsis">
  1254. Creating Workload Identity Service Accounts
  1255. </span>
  1256. </a>
  1257. </li>
  1258. <li class="md-nav__item">
  1259. <a href="#using-service-accounts-directly" class="md-nav__link">
  1260. <span class="md-ellipsis">
  1261. Using Service Accounts directly
  1262. </span>
  1263. </a>
  1264. </li>
  1265. <li class="md-nav__item">
  1266. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  1267. <span class="md-ellipsis">
  1268. Using Pod-based Workload Identity
  1269. </span>
  1270. </a>
  1271. </li>
  1272. </ul>
  1273. </nav>
  1274. </li>
  1275. <li class="md-nav__item">
  1276. <a href="#gcp-service-account-authentication" class="md-nav__link">
  1277. <span class="md-ellipsis">
  1278. GCP Service Account authentication
  1279. </span>
  1280. </a>
  1281. <nav class="md-nav" aria-label="GCP Service Account authentication">
  1282. <ul class="md-nav__list">
  1283. <li class="md-nav__item">
  1284. <a href="#update-secret-store" class="md-nav__link">
  1285. <span class="md-ellipsis">
  1286. Update secret store
  1287. </span>
  1288. </a>
  1289. </li>
  1290. <li class="md-nav__item">
  1291. <a href="#creating-external-secret" class="md-nav__link">
  1292. <span class="md-ellipsis">
  1293. Creating external secret
  1294. </span>
  1295. </a>
  1296. </li>
  1297. </ul>
  1298. </nav>
  1299. </li>
  1300. <li class="md-nav__item">
  1301. <a href="#pushsecret-owning-an-existing-google-secret-manager-secret" class="md-nav__link">
  1302. <span class="md-ellipsis">
  1303. PushSecret owning an existing Google Secret Manager Secret
  1304. </span>
  1305. </a>
  1306. </li>
  1307. <li class="md-nav__item">
  1308. <a href="#secret-replication-and-encryption-configuration" class="md-nav__link">
  1309. <span class="md-ellipsis">
  1310. Secret Replication and Encryption Configuration
  1311. </span>
  1312. </a>
  1313. <nav class="md-nav" aria-label="Secret Replication and Encryption Configuration">
  1314. <ul class="md-nav__list">
  1315. <li class="md-nav__item">
  1316. <a href="#location-and-replication" class="md-nav__link">
  1317. <span class="md-ellipsis">
  1318. Location and Replication
  1319. </span>
  1320. </a>
  1321. </li>
  1322. <li class="md-nav__item">
  1323. <a href="#customer-managed-encryption-keys-cmek" class="md-nav__link">
  1324. <span class="md-ellipsis">
  1325. Customer-Managed Encryption Keys (CMEK)
  1326. </span>
  1327. </a>
  1328. </li>
  1329. </ul>
  1330. </nav>
  1331. </li>
  1332. <li class="md-nav__item">
  1333. <a href="#migration-guide-pushsecret-metadata-format-v011x-to-v0120" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. Migration Guide: PushSecret Metadata Format (v0.11.x to v0.12.0)
  1336. </span>
  1337. </a>
  1338. <nav class="md-nav" aria-label="Migration Guide: PushSecret Metadata Format (v0.11.x to v0.12.0)">
  1339. <ul class="md-nav__list">
  1340. <li class="md-nav__item">
  1341. <a href="#old-format-v011x" class="md-nav__link">
  1342. <span class="md-ellipsis">
  1343. Old Format (v0.11.x)
  1344. </span>
  1345. </a>
  1346. </li>
  1347. <li class="md-nav__item">
  1348. <a href="#new-format-v0120" class="md-nav__link">
  1349. <span class="md-ellipsis">
  1350. New Format (v0.12.0+)
  1351. </span>
  1352. </a>
  1353. </li>
  1354. </ul>
  1355. </nav>
  1356. </li>
  1357. </ul>
  1358. </nav>
  1359. </li>
  1360. </ul>
  1361. </nav>
  1362. </div>
  1363. </div>
  1364. </div>
  1365. <div class="md-content" data-md-component="content">
  1366. <article class="md-content__inner md-typeset">
  1367. <h1>Google Cloud Secret Manager</h1>
  1368. <h2 id="google-cloud-secret-manager">Google Cloud Secret Manager</h2>
  1369. <p>External Secrets Operator integrates with <a href="https://cloud.google.com/secret-manager">GCP Secret Manager</a> for secret management.</p>
  1370. <h2 id="authentication">Authentication</h2>
  1371. <h3 id="workload-identity">Workload Identity</h3>
  1372. <p>Your Google Kubernetes Engine (GKE) applications can consume GCP services like Secrets Manager without using static, long-lived authentication tokens. This is our recommended approach of handling credentials in GCP. ESO offers two options for integrating with GKE workload identity: <strong>pod-based workload identity</strong> and <strong>using service accounts directly</strong>. Before using either way you need to create a service account - this is covered below.</p>
  1373. <h4 id="creating-workload-identity-service-accounts">Creating Workload Identity Service Accounts</h4>
  1374. <p>You can find the documentation for Workload Identity <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">here</a>. We will walk you through how to navigate it here.</p>
  1375. <p>Search <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">the document</a> for this editable values and change them to your values:
  1376. <em>Note: If you have installed ESO, a serviceaccount has already been created. You can either patch the existing <code>external-secrets</code> SA or create a new one that fits your needs.</em></p>
  1377. <ul>
  1378. <li><code>CLUSTER_NAME</code>: The name of your cluster</li>
  1379. <li><code>PROJECT_ID</code>: Your project ID (not your Project number nor your Project name)</li>
  1380. <li><code>K8S_NAMESPACE</code>: For us following these steps here it will be <code>es</code>, but this will be the namespace where you deployed the external-secrets operator</li>
  1381. <li><code>KSA_NAME</code>: external-secrets (if you are not creating a new one to attach to the deployment)</li>
  1382. <li><code>GSA_NAME</code>: external-secrets for simplicity, or something else if you have to follow different naming conventions for cloud resources</li>
  1383. <li><code>ROLE_NAME</code>: should be <code>roles/secretmanager.secretAccessor</code> - so you make the pod only be able to access secrets on Secret Manager</li>
  1384. </ul>
  1385. <h4 id="using-service-accounts-directly">Using Service Accounts directly</h4>
  1386. <p>Let's assume you have created a service account correctly and attached a appropriate workload identity. It should roughly look like this:</p>
  1387. <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>
  1388. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1389. <span class="nt">metadata</span><span class="p">:</span>
  1390. <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">external-secrets</span>
  1391. <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">es</span>
  1392. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1393. <span class="w"> </span><span class="nt">iam.gke.io/gcp-service-account</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-team-a@my-project.iam.gserviceaccount.com</span>
  1394. </code></pre></div>
  1395. <p>You can reference this particular ServiceAccount in a <code>SecretStore</code> or <code>ClusterSecretStore</code>. It's important that you also set the <code>projectID</code>, <code>clusterLocation</code> and <code>clusterName</code>. The Namespace on the <code>serviceAccountRef</code> is ignored when using a <code>SecretStore</code> resource. This is needed to isolate the namespaces properly.</p>
  1396. <p><em>When filling <code>clusterLocation</code> parameter keep in mind if it is Regional or Zonal cluster.</em></p>
  1397. <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>
  1398. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1399. <span class="nt">metadata</span><span class="p">:</span>
  1400. <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-store</span>
  1401. <span class="nt">spec</span><span class="p">:</span>
  1402. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1403. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1404. <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">alphabet-123</span>
  1405. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1406. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span>
  1407. <span class="w"> </span><span class="c1"># name of the cluster Location, region or zone</span>
  1408. <span class="w"> </span><span class="nt">clusterLocation</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">europe-central2</span>
  1409. <span class="w"> </span><span class="c1"># name of the GKE cluster</span>
  1410. <span class="w"> </span><span class="nt">clusterName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpha-cluster-42</span>
  1411. <span class="w"> </span><span class="c1"># projectID of the cluster (if omitted defaults to spec.provider.gcpsm.projectID)</span>
  1412. <span class="w"> </span><span class="nt">clusterProjectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-cluster-project</span>
  1413. <span class="w"> </span><span class="c1"># reference the sa from above</span>
  1414. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1415. <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">team-a</span>
  1416. <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">team-a</span>
  1417. </code></pre></div>
  1418. <p><em>You need to give the Google service account the <code>roles/iam.serviceAccountTokenCreator</code> role so it can generate a service account token for you (not necessary in the Pod-based Workload Identity bellow)</em></p>
  1419. <h4 id="using-pod-based-workload-identity">Using Pod-based Workload Identity</h4>
  1420. <p>You can attach a Workload Identity directly to the ESO pod. ESO then has access to all the APIs defined in the attached service account policy. You attach the workload identity by (1) creating a service account with a attached workload identity (described above) and (2) using this particular service account in the pod's <code>serviceAccountName</code> field.</p>
  1421. <p>For this example we will assume that you installed ESO using helm and that you named the chart installation <code>external-secrets</code> and the namespace where it lives <code>es</code> like:</p>
  1422. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets<span class="w"> </span>--namespace<span class="w"> </span>es
  1423. </code></pre></div>
  1424. <p>Then most of the resources would have this name, the important one here being the k8s service account attached to the external-secrets operator deployment:</p>
  1425. <div class="highlight"><pre><span></span><code><span class="c1"># ...</span>
  1426. <span class="w"> </span><span class="nt">containers</span><span class="p">:</span>
  1427. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghcr.io/external-secrets/external-secrets:vVERSION</span>
  1428. <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">external-secrets</span>
  1429. <span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
  1430. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containerPort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span>
  1431. <span class="w"> </span><span class="nt">protocol</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TCP</span>
  1432. <span class="w"> </span><span class="nt">restartPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Always</span>
  1433. <span class="w"> </span><span class="nt">schedulerName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default-scheduler</span>
  1434. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1435. <span class="w"> </span><span class="nt">serviceAccountName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"> </span><span class="c1"># &lt;--- here</span>
  1436. </code></pre></div>
  1437. <p>The pod now has the identity. Now you need to configure the <code>SecretStore</code>.
  1438. You just need to set the <code>projectID</code>, all other fields can be omitted.</p>
  1439. <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>
  1440. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1441. <span class="nt">metadata</span><span class="p">:</span>
  1442. <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-store</span>
  1443. <span class="nt">spec</span><span class="p">:</span>
  1444. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1445. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1446. <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">alphabet-123</span>
  1447. </code></pre></div>
  1448. <h3 id="gcp-service-account-authentication">GCP Service Account authentication</h3>
  1449. <p>You can use <a href="https://cloud.google.com/iam/docs/service-accounts">GCP Service Account</a> to authenticate with GCP. These are static, long-lived credentials. A GCP Service Account is a JSON file that needs to be stored in a <code>Kind=Secret</code>. ESO will use that Secret to authenticate with GCP. See here how you <a href="https://cloud.google.com/iam/docs/creating-managing-service-accounts">manage GCP Service Accounts</a>.
  1450. After creating a GCP Service account go to <code>IAM &amp; Admin</code> web UI, click <code>ADD ANOTHER ROLE</code> button, add <code>Secret Manager Secret Accessor</code> role to this service account.
  1451. The <code>Secret Manager Secret Accessor</code> role is required to access secrets.</p>
  1452. <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>
  1453. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1454. <span class="nt">metadata</span><span class="p">:</span>
  1455. <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">gcpsm-secret</span>
  1456. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1457. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gcpsm</span>
  1458. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  1459. <span class="nt">stringData</span><span class="p">:</span>
  1460. <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>
  1461. <span class="w"> </span><span class="no">{</span>
  1462. <span class="w"> </span><span class="no">&quot;type&quot;: &quot;service_account&quot;,</span>
  1463. <span class="w"> </span><span class="no">&quot;project_id&quot;: &quot;external-secrets-operator&quot;,</span>
  1464. <span class="w"> </span><span class="no">&quot;private_key_id&quot;: &quot;&quot;,</span>
  1465. <span class="w"> </span><span class="no">&quot;private_key&quot;: &quot;-----BEGIN PRIVATE KEY-----\nA key\n-----END PRIVATE KEY-----\n&quot;,</span>
  1466. <span class="w"> </span><span class="no">&quot;client_email&quot;: &quot;test-service-account@external-secrets-operator.iam.gserviceaccount.com&quot;,</span>
  1467. <span class="w"> </span><span class="no">&quot;client_id&quot;: &quot;client ID&quot;,</span>
  1468. <span class="w"> </span><span class="no">&quot;auth_uri&quot;: &quot;https://accounts.google.com/o/oauth2/auth&quot;,</span>
  1469. <span class="w"> </span><span class="no">&quot;token_uri&quot;: &quot;https://oauth2.googleapis.com/token&quot;,</span>
  1470. <span class="w"> </span><span class="no">&quot;auth_provider_x509_cert_url&quot;: &quot;https://www.googleapis.com/oauth2/v1/certs&quot;,</span>
  1471. <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>
  1472. <span class="w"> </span><span class="no">}</span>
  1473. </code></pre></div>
  1474. <h4 id="update-secret-store">Update secret store</h4>
  1475. <p>Be sure the <code>gcpsm</code> provider is listed in the <code>Kind=SecretStore</code></p>
  1476. <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>
  1477. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1478. <span class="nt">metadata</span><span class="p">:</span>
  1479. <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-store</span>
  1480. <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">example</span>
  1481. <span class="nt">spec</span><span class="p">:</span>
  1482. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1483. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"> </span><span class="c1"># gcpsm provider</span>
  1484. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1485. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1486. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1487. <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">gcpsm-secret</span><span class="w"> </span><span class="c1"># secret name containing SA key</span>
  1488. <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><span class="w"> </span><span class="c1"># key name containing SA key</span>
  1489. <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">alphabet-123</span><span class="w"> </span><span class="c1"># name of Google Cloud project</span>
  1490. </code></pre></div>
  1491. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>SecretAccessKeyRef</code> with the namespace of the secret that we just created.</p>
  1492. <h4 id="creating-external-secret">Creating external secret</h4>
  1493. <p>To create a kubernetes secret from the GCP Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  1494. <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>
  1495. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1496. <span class="nt">metadata</span><span class="p">:</span>
  1497. <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">database-credentials</span>
  1498. <span class="nt">spec</span><span class="p">:</span>
  1499. <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><span class="w"> </span><span class="c1"># rate SecretManager pulls GCPSM</span>
  1500. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1501. <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>
  1502. <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-store</span><span class="w"> </span><span class="c1"># name of the SecretStore (or kind specified)</span>
  1503. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1504. <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">database-credentials</span><span class="w"> </span><span class="c1"># name of the k8s Secret to be created</span>
  1505. <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>
  1506. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1507. <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">database_username</span>
  1508. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1509. <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">database_username</span><span class="w"> </span><span class="c1"># name of the GCPSM secret key</span>
  1510. <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">database_password</span>
  1511. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1512. <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">database_password</span><span class="w"> </span><span class="c1"># name of the GCPSM secret key</span>
  1513. </code></pre></div>
  1514. <p>The operator will fetch the GCP Secret Manager secret and inject it as a <code>Kind=Secret</code>
  1515. <div class="highlight"><pre><span></span><code>kubectl get secret secret-to-be-created -n &lt;namespace&gt; -o jsonpath=&#39;{.data.dev-secret-test}&#39; | base64 -d
  1516. </code></pre></div></p>
  1517. <h3 id="pushsecret-owning-an-existing-google-secret-manager-secret">PushSecret owning an existing Google Secret Manager Secret</h3>
  1518. <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>
  1519. <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>
  1520. <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>
  1521. <p>Example of using the <code>mergePolicy</code> field:</p>
  1522. <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>
  1523. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1524. <span class="nt">metadata</span><span class="p">:</span>
  1525. <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>
  1526. <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>
  1527. <span class="nt">spec</span><span class="p">:</span>
  1528. <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>
  1529. <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>
  1530. <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>
  1531. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1532. <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>
  1533. <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>
  1534. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1535. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1536. <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>
  1537. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1538. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1539. <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>
  1540. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1541. <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>
  1542. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1543. <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>
  1544. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1545. <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>
  1546. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1547. <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>
  1548. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1549. <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>
  1550. </code></pre></div>
  1551. <h3 id="secret-replication-and-encryption-configuration">Secret Replication and Encryption Configuration</h3>
  1552. <h4 id="location-and-replication">Location and Replication</h4>
  1553. <p>By default, secrets are automatically replicated across multiple regions. You can specify a single location for your secrets by setting the <code>location</code> field:</p>
  1554. <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>
  1555. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1556. <span class="nt">metadata</span><span class="p">:</span>
  1557. <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>
  1558. <span class="nt">spec</span><span class="p">:</span>
  1559. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1560. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1561. <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>
  1562. <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"># Specify a single location</span>
  1563. </code></pre></div>
  1564. <h4 id="customer-managed-encryption-keys-cmek">Customer-Managed Encryption Keys (CMEK)</h4>
  1565. <p>You can use your own encryption keys to encrypt secrets at rest. To use Customer-Managed Encryption Keys (CMEK), you need to:</p>
  1566. <ol>
  1567. <li>Create a Cloud KMS key</li>
  1568. <li>Grant the service account the <code>roles/cloudkms.cryptoKeyEncrypterDecrypter</code> role on the key</li>
  1569. <li>Specify the key in the PushSecret metadata</li>
  1570. </ol>
  1571. <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>
  1572. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1573. <span class="nt">metadata</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">pushsecret-example</span>
  1575. <span class="nt">spec</span><span class="p">:</span>
  1576. <span class="w"> </span><span class="c1"># ... other fields ...</span>
  1577. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1578. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1579. <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>
  1580. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1581. <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>
  1582. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1583. <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>
  1584. <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>
  1585. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1586. <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>
  1587. </code></pre></div>
  1588. <p>Note: When using CMEK, you must specify a location in the SecretStore as customer-managed encryption keys are region-specific.</p>
  1589. <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>
  1590. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1591. <span class="nt">metadata</span><span class="p">:</span>
  1592. <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>
  1593. <span class="nt">spec</span><span class="p">:</span>
  1594. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1595. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1596. <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>
  1597. <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>
  1598. </code></pre></div>
  1599. <h3 id="migration-guide-pushsecret-metadata-format-v011x-to-v0120">Migration Guide: PushSecret Metadata Format (v0.11.x to v0.12.0)</h3>
  1600. <p>In version 0.12.0, the metadata format for PushSecrets has been standardized to use a structured format. If you're upgrading from v0.11.x, you'll need to update your PushSecret specifications.</p>
  1601. <h4 id="old-format-v011x">Old Format (v0.11.x)</h4>
  1602. <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>
  1603. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1604. <span class="nt">spec</span><span class="p">:</span>
  1605. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1606. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1607. <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>
  1608. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1609. <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>
  1610. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1611. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1612. <span class="w"> </span><span class="nt">key1</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value1&quot;</span>
  1613. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1614. <span class="w"> </span><span class="nt">key2</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value2&quot;</span>
  1615. <span class="w"> </span><span class="nt">topics</span><span class="p">:</span>
  1616. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;topic1&quot;</span>
  1617. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;topic2&quot;</span>
  1618. </code></pre></div>
  1619. <h4 id="new-format-v0120">New Format (v0.12.0+)</h4>
  1620. <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>
  1621. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1622. <span class="nt">spec</span><span class="p">:</span>
  1623. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1624. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1625. <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>
  1626. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1627. <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>
  1628. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1629. <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>
  1630. <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>
  1631. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1632. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1633. <span class="w"> </span><span class="nt">key1</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value1&quot;</span>
  1634. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1635. <span class="w"> </span><span class="nt">key2</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value2&quot;</span>
  1636. <span class="w"> </span><span class="nt">topics</span><span class="p">:</span>
  1637. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;topic1&quot;</span>
  1638. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;topic2&quot;</span>
  1639. <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><span class="w"> </span><span class="c1"># Optional: for CMEK</span>
  1640. </code></pre></div>
  1641. </article>
  1642. </div>
  1643. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1644. </div>
  1645. </main>
  1646. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1647. <footer class="md-footer">
  1648. <div class="md-footer-meta md-typeset">
  1649. <div class="md-footer-meta__inner md-grid">
  1650. <div class="md-copyright">
  1651. <div class="md-copyright__highlight">
  1652. &copy; 2024 The external-secrets Authors.<br/>
  1653. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1654. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1655. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1656. </div>
  1657. Made with
  1658. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1659. Material for MkDocs
  1660. </a>
  1661. </div>
  1662. </div>
  1663. </div>
  1664. </footer>
  1665. </div>
  1666. <div class="md-dialog" data-md-component="dialog">
  1667. <div class="md-dialog__inner md-typeset"></div>
  1668. </div>
  1669. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "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>
  1670. <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
  1671. </body>
  1672. </html>