index.html 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756
  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="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <header class="md-header" data-md-component="header">
  27. <nav class="md-header__inner md-grid" aria-label="Header">
  28. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  29. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  30. </a>
  31. <label class="md-header__button md-icon" for="__drawer">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  33. </label>
  34. <div class="md-header__title" data-md-component="header-title">
  35. <div class="md-header__ellipsis">
  36. <div class="md-header__topic">
  37. <span class="md-ellipsis">
  38. External Secrets Operator
  39. </span>
  40. </div>
  41. <div class="md-header__topic" data-md-component="header-topic">
  42. <span class="md-ellipsis">
  43. API specification
  44. </span>
  45. </div>
  46. </div>
  47. </div>
  48. <label class="md-header__button md-icon" for="__search">
  49. <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.516 6.516 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 5z"/></svg>
  50. </label>
  51. <div class="md-search" data-md-component="search" role="dialog">
  52. <label class="md-search__overlay" for="__search"></label>
  53. <div class="md-search__inner" role="search">
  54. <form class="md-search__form" name="search">
  55. <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" data-md-state="active" required>
  56. <label class="md-search__icon md-icon" for="__search">
  57. <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.516 6.516 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 5z"/></svg>
  58. <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 11h12z"/></svg>
  59. </label>
  60. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  61. <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 12 19 6.41z"/></svg>
  62. </button>
  63. </form>
  64. <div class="md-search__output">
  65. <div class="md-search__scrollwrap" data-md-scrollfix>
  66. <div class="md-search-result" data-md-component="search-result">
  67. <div class="md-search-result__meta">
  68. Initializing search
  69. </div>
  70. <ol class="md-search-result__list"></ol>
  71. </div>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="md-header__source">
  77. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  78. <div class="md-source__icon md-icon">
  79. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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.81z"/></svg>
  80. </div>
  81. <div class="md-source__repository">
  82. External Secrets Operator
  83. </div>
  84. </a>
  85. </div>
  86. </nav>
  87. </header>
  88. <div class="md-container" data-md-component="container">
  89. <main class="md-main" data-md-component="main">
  90. <div class="md-main__inner md-grid">
  91. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  92. <div class="md-sidebar__scrollwrap">
  93. <div class="md-sidebar__inner">
  94. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  95. <label class="md-nav__title" for="__drawer">
  96. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  98. </a>
  99. External Secrets Operator
  100. </label>
  101. <div class="md-nav__source">
  102. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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.81z"/></svg>
  105. </div>
  106. <div class="md-source__repository">
  107. External Secrets Operator
  108. </div>
  109. </a>
  110. </div>
  111. <ul class="md-nav__list" data-md-scrollfix>
  112. <li class="md-nav__item">
  113. <a href=".." class="md-nav__link">
  114. Introduction
  115. </a>
  116. </li>
  117. <li class="md-nav__item">
  118. <a href="../api-overview/" class="md-nav__link">
  119. Overview
  120. </a>
  121. </li>
  122. <li class="md-nav__item md-nav__item--nested">
  123. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  124. <label class="md-nav__link" for="__nav_3">
  125. API Types
  126. <span class="md-nav__icon md-icon"></span>
  127. </label>
  128. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  129. <label class="md-nav__title" for="__nav_3">
  130. <span class="md-nav__icon md-icon"></span>
  131. API Types
  132. </label>
  133. <ul class="md-nav__list" data-md-scrollfix>
  134. <li class="md-nav__item">
  135. <a href="../api-externalsecret/" class="md-nav__link">
  136. ExternalSecret
  137. </a>
  138. </li>
  139. <li class="md-nav__item">
  140. <a href="../api-secretstore/" class="md-nav__link">
  141. SecretStore
  142. </a>
  143. </li>
  144. <li class="md-nav__item">
  145. <a href="../api-clustersecretstore/" class="md-nav__link">
  146. ClusterSecretStore
  147. </a>
  148. </li>
  149. </ul>
  150. </nav>
  151. </li>
  152. <li class="md-nav__item md-nav__item--nested">
  153. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  154. <label class="md-nav__link" for="__nav_4">
  155. Guides
  156. <span class="md-nav__icon md-icon"></span>
  157. </label>
  158. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  159. <label class="md-nav__title" for="__nav_4">
  160. <span class="md-nav__icon md-icon"></span>
  161. Guides
  162. </label>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item">
  165. <a href="../guides-introduction/" class="md-nav__link">
  166. Introduction
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="../guides-getting-started/" class="md-nav__link">
  171. Getting started
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="../guides-templating/" class="md-nav__link">
  176. Advanced Templating
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  181. All keys, One secret
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  186. Common K8S Secret Types
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="../guides-multi-tenancy/" class="md-nav__link">
  191. Multi Tenancy
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../guides-metrics/" class="md-nav__link">
  196. Metrics
  197. </a>
  198. </li>
  199. </ul>
  200. </nav>
  201. </li>
  202. <li class="md-nav__item md-nav__item--nested">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  204. <label class="md-nav__link" for="__nav_5">
  205. Provider
  206. <span class="md-nav__icon md-icon"></span>
  207. </label>
  208. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  209. <label class="md-nav__title" for="__nav_5">
  210. <span class="md-nav__icon md-icon"></span>
  211. Provider
  212. </label>
  213. <ul class="md-nav__list" data-md-scrollfix>
  214. <li class="md-nav__item md-nav__item--nested">
  215. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  216. <label class="md-nav__link" for="__nav_5_1">
  217. AWS
  218. <span class="md-nav__icon md-icon"></span>
  219. </label>
  220. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  221. <label class="md-nav__title" for="__nav_5_1">
  222. <span class="md-nav__icon md-icon"></span>
  223. AWS
  224. </label>
  225. <ul class="md-nav__list" data-md-scrollfix>
  226. <li class="md-nav__item">
  227. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  228. Secrets Manager
  229. </a>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  233. Parameter Store
  234. </a>
  235. </li>
  236. </ul>
  237. </nav>
  238. </li>
  239. <li class="md-nav__item md-nav__item--nested">
  240. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  241. <label class="md-nav__link" for="__nav_5_2">
  242. Azure
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  246. <label class="md-nav__title" for="__nav_5_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. Azure
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../provider-azure-key-vault/" class="md-nav__link">
  253. Key Vault
  254. </a>
  255. </li>
  256. </ul>
  257. </nav>
  258. </li>
  259. <li class="md-nav__item md-nav__item--nested">
  260. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  261. <label class="md-nav__link" for="__nav_5_3">
  262. Google
  263. <span class="md-nav__icon md-icon"></span>
  264. </label>
  265. <nav class="md-nav" aria-label="Google" data-md-level="2">
  266. <label class="md-nav__title" for="__nav_5_3">
  267. <span class="md-nav__icon md-icon"></span>
  268. Google
  269. </label>
  270. <ul class="md-nav__list" data-md-scrollfix>
  271. <li class="md-nav__item">
  272. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  273. Secrets Manager
  274. </a>
  275. </li>
  276. </ul>
  277. </nav>
  278. </li>
  279. <li class="md-nav__item md-nav__item--nested">
  280. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  281. <label class="md-nav__link" for="__nav_5_4">
  282. IBM
  283. <span class="md-nav__icon md-icon"></span>
  284. </label>
  285. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  286. <label class="md-nav__title" for="__nav_5_4">
  287. <span class="md-nav__icon md-icon"></span>
  288. IBM
  289. </label>
  290. <ul class="md-nav__list" data-md-scrollfix>
  291. <li class="md-nav__item">
  292. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  293. Secrets Manager
  294. </a>
  295. </li>
  296. </ul>
  297. </nav>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  301. HashiCorp Vault
  302. </a>
  303. </li>
  304. <li class="md-nav__item md-nav__item--nested">
  305. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_6" type="checkbox" id="__nav_5_6" >
  306. <label class="md-nav__link" for="__nav_5_6">
  307. Yandex
  308. <span class="md-nav__icon md-icon"></span>
  309. </label>
  310. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  311. <label class="md-nav__title" for="__nav_5_6">
  312. <span class="md-nav__icon md-icon"></span>
  313. Yandex
  314. </label>
  315. <ul class="md-nav__list" data-md-scrollfix>
  316. <li class="md-nav__item">
  317. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  318. Lockbox
  319. </a>
  320. </li>
  321. </ul>
  322. </nav>
  323. </li>
  324. <li class="md-nav__item md-nav__item--nested">
  325. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  326. <label class="md-nav__link" for="__nav_5_7">
  327. Gitlab
  328. <span class="md-nav__icon md-icon"></span>
  329. </label>
  330. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  331. <label class="md-nav__title" for="__nav_5_7">
  332. <span class="md-nav__icon md-icon"></span>
  333. Gitlab
  334. </label>
  335. <ul class="md-nav__list" data-md-scrollfix>
  336. <li class="md-nav__item">
  337. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  338. Gitlab Project Variables
  339. </a>
  340. </li>
  341. </ul>
  342. </nav>
  343. </li>
  344. <li class="md-nav__item md-nav__item--nested">
  345. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  346. <label class="md-nav__link" for="__nav_5_8">
  347. Oracle
  348. <span class="md-nav__icon md-icon"></span>
  349. </label>
  350. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  351. <label class="md-nav__title" for="__nav_5_8">
  352. <span class="md-nav__icon md-icon"></span>
  353. Oracle
  354. </label>
  355. <ul class="md-nav__list" data-md-scrollfix>
  356. <li class="md-nav__item">
  357. <a href="../provider-oracle-vault/" class="md-nav__link">
  358. Oracle Vault
  359. </a>
  360. </li>
  361. </ul>
  362. </nav>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  368. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  369. <label class="md-nav__link" for="__nav_6">
  370. References
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <nav class="md-nav" aria-label="References" data-md-level="1">
  374. <label class="md-nav__title" for="__nav_6">
  375. <span class="md-nav__icon md-icon"></span>
  376. References
  377. </label>
  378. <ul class="md-nav__list" data-md-scrollfix>
  379. <li class="md-nav__item md-nav__item--active">
  380. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  381. <a href="./" class="md-nav__link md-nav__link--active">
  382. API specification
  383. </a>
  384. </li>
  385. </ul>
  386. </nav>
  387. </li>
  388. <li class="md-nav__item md-nav__item--nested">
  389. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  390. <label class="md-nav__link" for="__nav_7">
  391. Contributing
  392. <span class="md-nav__icon md-icon"></span>
  393. </label>
  394. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  395. <label class="md-nav__title" for="__nav_7">
  396. <span class="md-nav__icon md-icon"></span>
  397. Contributing
  398. </label>
  399. <ul class="md-nav__list" data-md-scrollfix>
  400. <li class="md-nav__item">
  401. <a href="../contributing-devguide/" class="md-nav__link">
  402. Developer guide
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../contributing-process/" class="md-nav__link">
  407. Contributing Process
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../contributing-coc/" class="md-nav__link">
  412. Code of Conduct
  413. </a>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../deprecation-policy/" class="md-nav__link">
  420. Deprecation Policy
  421. </a>
  422. </li>
  423. </ul>
  424. </nav>
  425. </div>
  426. </div>
  427. </div>
  428. <div class="md-content" data-md-component="content">
  429. <article class="md-content__inner md-typeset">
  430. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  431. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  432. </a>
  433. <h1>API specification</h1>
  434. <p>Packages:</p>
  435. <ul>
  436. <li>
  437. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  438. </li>
  439. </ul>
  440. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  441. <p>
  442. <p>Package v1alpha1 contains resources for external-secrets</p>
  443. </p>
  444. <p>Resource Types:
  445. <ul></ul>
  446. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  447. </h3>
  448. <p>
  449. (<em>Appears on:</em>
  450. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  451. </p>
  452. <p>
  453. <p>AWSAuth tells the controller how to do authentication with aws.
  454. Only one of secretRef or jwt can be specified.
  455. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  456. </p>
  457. <table>
  458. <thead>
  459. <tr>
  460. <th>Field</th>
  461. <th>Description</th>
  462. </tr>
  463. </thead>
  464. <tbody>
  465. <tr>
  466. <td>
  467. <code>secretRef</code></br>
  468. <em>
  469. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  470. AWSAuthSecretRef
  471. </a>
  472. </em>
  473. </td>
  474. <td>
  475. <em>(Optional)</em>
  476. </td>
  477. </tr>
  478. <tr>
  479. <td>
  480. <code>jwt</code></br>
  481. <em>
  482. <a href="#external-secrets.io/v1alpha1.AWSJWTAuth">
  483. AWSJWTAuth
  484. </a>
  485. </em>
  486. </td>
  487. <td>
  488. <em>(Optional)</em>
  489. </td>
  490. </tr>
  491. </tbody>
  492. </table>
  493. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  494. </h3>
  495. <p>
  496. (<em>Appears on:</em>
  497. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  498. </p>
  499. <p>
  500. <p>AWSAuthSecretRef holds secret references for AWS credentials
  501. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  502. </p>
  503. <table>
  504. <thead>
  505. <tr>
  506. <th>Field</th>
  507. <th>Description</th>
  508. </tr>
  509. </thead>
  510. <tbody>
  511. <tr>
  512. <td>
  513. <code>accessKeyIDSecretRef</code></br>
  514. <em>
  515. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  516. </em>
  517. </td>
  518. <td>
  519. <p>The AccessKeyID is used for authentication</p>
  520. </td>
  521. </tr>
  522. <tr>
  523. <td>
  524. <code>secretAccessKeySecretRef</code></br>
  525. <em>
  526. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  527. </em>
  528. </td>
  529. <td>
  530. <p>The SecretAccessKey is used for authentication</p>
  531. </td>
  532. </tr>
  533. </tbody>
  534. </table>
  535. <h3 id="external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
  536. </h3>
  537. <p>
  538. (<em>Appears on:</em>
  539. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  540. </p>
  541. <p>
  542. <p>Authenticate against AWS using service account tokens.</p>
  543. </p>
  544. <table>
  545. <thead>
  546. <tr>
  547. <th>Field</th>
  548. <th>Description</th>
  549. </tr>
  550. </thead>
  551. <tbody>
  552. <tr>
  553. <td>
  554. <code>serviceAccountRef</code></br>
  555. <em>
  556. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  557. </em>
  558. </td>
  559. <td>
  560. </td>
  561. </tr>
  562. </tbody>
  563. </table>
  564. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  565. </h3>
  566. <p>
  567. (<em>Appears on:</em>
  568. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  569. </p>
  570. <p>
  571. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  572. </p>
  573. <table>
  574. <thead>
  575. <tr>
  576. <th>Field</th>
  577. <th>Description</th>
  578. </tr>
  579. </thead>
  580. <tbody>
  581. <tr>
  582. <td>
  583. <code>service</code></br>
  584. <em>
  585. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  586. AWSServiceType
  587. </a>
  588. </em>
  589. </td>
  590. <td>
  591. <p>Service defines which service should be used to fetch the secrets</p>
  592. </td>
  593. </tr>
  594. <tr>
  595. <td>
  596. <code>auth</code></br>
  597. <em>
  598. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  599. AWSAuth
  600. </a>
  601. </em>
  602. </td>
  603. <td>
  604. <em>(Optional)</em>
  605. <p>Auth defines the information necessary to authenticate against AWS
  606. if not set aws sdk will infer credentials from your environment
  607. see: <a href="https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials">https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials</a></p>
  608. </td>
  609. </tr>
  610. <tr>
  611. <td>
  612. <code>role</code></br>
  613. <em>
  614. string
  615. </em>
  616. </td>
  617. <td>
  618. <em>(Optional)</em>
  619. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  620. </td>
  621. </tr>
  622. <tr>
  623. <td>
  624. <code>region</code></br>
  625. <em>
  626. string
  627. </em>
  628. </td>
  629. <td>
  630. <p>AWS Region to be used for the provider</p>
  631. </td>
  632. </tr>
  633. </tbody>
  634. </table>
  635. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  636. (<code>string</code> alias)</p></h3>
  637. <p>
  638. (<em>Appears on:</em>
  639. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  640. </p>
  641. <p>
  642. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  643. </p>
  644. <table>
  645. <thead>
  646. <tr>
  647. <th>Value</th>
  648. <th>Description</th>
  649. </tr>
  650. </thead>
  651. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  652. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  653. see: <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html">https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html</a></p>
  654. </td>
  655. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  656. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  657. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</a></p>
  658. </td>
  659. </tr></tbody>
  660. </table>
  661. <h3 id="external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth
  662. </h3>
  663. <p>
  664. (<em>Appears on:</em>
  665. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider</a>)
  666. </p>
  667. <p>
  668. <p>AlibabaAuth contains a secretRef for credentials.</p>
  669. </p>
  670. <table>
  671. <thead>
  672. <tr>
  673. <th>Field</th>
  674. <th>Description</th>
  675. </tr>
  676. </thead>
  677. <tbody>
  678. <tr>
  679. <td>
  680. <code>secretRef</code></br>
  681. <em>
  682. <a href="#external-secrets.io/v1alpha1.AlibabaAuthSecretRef">
  683. AlibabaAuthSecretRef
  684. </a>
  685. </em>
  686. </td>
  687. <td>
  688. </td>
  689. </tr>
  690. </tbody>
  691. </table>
  692. <h3 id="external-secrets.io/v1alpha1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  693. </h3>
  694. <p>
  695. (<em>Appears on:</em>
  696. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth</a>)
  697. </p>
  698. <p>
  699. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  700. </p>
  701. <table>
  702. <thead>
  703. <tr>
  704. <th>Field</th>
  705. <th>Description</th>
  706. </tr>
  707. </thead>
  708. <tbody>
  709. <tr>
  710. <td>
  711. <code>accessKeyIDSecretRef</code></br>
  712. <em>
  713. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  714. </em>
  715. </td>
  716. <td>
  717. <p>The AccessKeyID is used for authentication</p>
  718. </td>
  719. </tr>
  720. <tr>
  721. <td>
  722. <code>accessKeySecretSecretRef</code></br>
  723. <em>
  724. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  725. </em>
  726. </td>
  727. <td>
  728. <p>The AccessKeySecret is used for authentication</p>
  729. </td>
  730. </tr>
  731. </tbody>
  732. </table>
  733. <h3 id="external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider
  734. </h3>
  735. <p>
  736. (<em>Appears on:</em>
  737. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  738. </p>
  739. <p>
  740. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  741. </p>
  742. <table>
  743. <thead>
  744. <tr>
  745. <th>Field</th>
  746. <th>Description</th>
  747. </tr>
  748. </thead>
  749. <tbody>
  750. <tr>
  751. <td>
  752. <code>auth</code></br>
  753. <em>
  754. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">
  755. AlibabaAuth
  756. </a>
  757. </em>
  758. </td>
  759. <td>
  760. </td>
  761. </tr>
  762. <tr>
  763. <td>
  764. <code>endpoint</code></br>
  765. <em>
  766. string
  767. </em>
  768. </td>
  769. <td>
  770. <em>(Optional)</em>
  771. </td>
  772. </tr>
  773. <tr>
  774. <td>
  775. <code>regionID</code></br>
  776. <em>
  777. string
  778. </em>
  779. </td>
  780. <td>
  781. <p>Alibaba Region to be used for the provider</p>
  782. </td>
  783. </tr>
  784. </tbody>
  785. </table>
  786. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  787. </h3>
  788. <p>
  789. (<em>Appears on:</em>
  790. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  791. </p>
  792. <p>
  793. <p>Configuration used to authenticate with Azure.</p>
  794. </p>
  795. <table>
  796. <thead>
  797. <tr>
  798. <th>Field</th>
  799. <th>Description</th>
  800. </tr>
  801. </thead>
  802. <tbody>
  803. <tr>
  804. <td>
  805. <code>clientId</code></br>
  806. <em>
  807. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  808. </em>
  809. </td>
  810. <td>
  811. <p>The Azure clientId of the service principle used for authentication.</p>
  812. </td>
  813. </tr>
  814. <tr>
  815. <td>
  816. <code>clientSecret</code></br>
  817. <em>
  818. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  819. </em>
  820. </td>
  821. <td>
  822. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  823. </td>
  824. </tr>
  825. </tbody>
  826. </table>
  827. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  828. </h3>
  829. <p>
  830. (<em>Appears on:</em>
  831. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  832. </p>
  833. <p>
  834. <p>Configures an store to sync secrets using Azure KV.</p>
  835. </p>
  836. <table>
  837. <thead>
  838. <tr>
  839. <th>Field</th>
  840. <th>Description</th>
  841. </tr>
  842. </thead>
  843. <tbody>
  844. <tr>
  845. <td>
  846. <code>vaultUrl</code></br>
  847. <em>
  848. string
  849. </em>
  850. </td>
  851. <td>
  852. <p>Vault Url from which the secrets to be fetched from.</p>
  853. </td>
  854. </tr>
  855. <tr>
  856. <td>
  857. <code>tenantId</code></br>
  858. <em>
  859. string
  860. </em>
  861. </td>
  862. <td>
  863. <p>TenantID configures the Azure Tenant to send requests to.</p>
  864. </td>
  865. </tr>
  866. <tr>
  867. <td>
  868. <code>authSecretRef</code></br>
  869. <em>
  870. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  871. AzureKVAuth
  872. </a>
  873. </em>
  874. </td>
  875. <td>
  876. <p>Auth configures how the operator authenticates with Azure.</p>
  877. </td>
  878. </tr>
  879. </tbody>
  880. </table>
  881. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  882. </h3>
  883. <p>
  884. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  885. </p>
  886. <table>
  887. <thead>
  888. <tr>
  889. <th>Field</th>
  890. <th>Description</th>
  891. </tr>
  892. </thead>
  893. <tbody>
  894. <tr>
  895. <td>
  896. <code>metadata</code></br>
  897. <em>
  898. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  899. Kubernetes meta/v1.ObjectMeta
  900. </a>
  901. </em>
  902. </td>
  903. <td>
  904. Refer to the Kubernetes API documentation for the fields of the
  905. <code>metadata</code> field.
  906. </td>
  907. </tr>
  908. <tr>
  909. <td>
  910. <code>spec</code></br>
  911. <em>
  912. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  913. SecretStoreSpec
  914. </a>
  915. </em>
  916. </td>
  917. <td>
  918. <br/>
  919. <br/>
  920. <table>
  921. <tr>
  922. <td>
  923. <code>controller</code></br>
  924. <em>
  925. string
  926. </em>
  927. </td>
  928. <td>
  929. <em>(Optional)</em>
  930. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  931. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  932. </td>
  933. </tr>
  934. <tr>
  935. <td>
  936. <code>provider</code></br>
  937. <em>
  938. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  939. SecretStoreProvider
  940. </a>
  941. </em>
  942. </td>
  943. <td>
  944. <p>Used to configure the provider. Only one provider may be set</p>
  945. </td>
  946. </tr>
  947. </table>
  948. </td>
  949. </tr>
  950. <tr>
  951. <td>
  952. <code>status</code></br>
  953. <em>
  954. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  955. SecretStoreStatus
  956. </a>
  957. </em>
  958. </td>
  959. <td>
  960. </td>
  961. </tr>
  962. </tbody>
  963. </table>
  964. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  965. </h3>
  966. <p>
  967. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  968. </p>
  969. <table>
  970. <thead>
  971. <tr>
  972. <th>Field</th>
  973. <th>Description</th>
  974. </tr>
  975. </thead>
  976. <tbody>
  977. <tr>
  978. <td>
  979. <code>metadata</code></br>
  980. <em>
  981. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  982. Kubernetes meta/v1.ObjectMeta
  983. </a>
  984. </em>
  985. </td>
  986. <td>
  987. Refer to the Kubernetes API documentation for the fields of the
  988. <code>metadata</code> field.
  989. </td>
  990. </tr>
  991. <tr>
  992. <td>
  993. <code>spec</code></br>
  994. <em>
  995. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  996. ExternalSecretSpec
  997. </a>
  998. </em>
  999. </td>
  1000. <td>
  1001. <br/>
  1002. <br/>
  1003. <table>
  1004. <tr>
  1005. <td>
  1006. <code>secretStoreRef</code></br>
  1007. <em>
  1008. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1009. SecretStoreRef
  1010. </a>
  1011. </em>
  1012. </td>
  1013. <td>
  1014. </td>
  1015. </tr>
  1016. <tr>
  1017. <td>
  1018. <code>target</code></br>
  1019. <em>
  1020. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1021. ExternalSecretTarget
  1022. </a>
  1023. </em>
  1024. </td>
  1025. <td>
  1026. </td>
  1027. </tr>
  1028. <tr>
  1029. <td>
  1030. <code>refreshInterval</code></br>
  1031. <em>
  1032. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1033. Kubernetes meta/v1.Duration
  1034. </a>
  1035. </em>
  1036. </td>
  1037. <td>
  1038. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1039. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  1040. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1041. </td>
  1042. </tr>
  1043. <tr>
  1044. <td>
  1045. <code>data</code></br>
  1046. <em>
  1047. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1048. []ExternalSecretData
  1049. </a>
  1050. </em>
  1051. </td>
  1052. <td>
  1053. <em>(Optional)</em>
  1054. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1055. </td>
  1056. </tr>
  1057. <tr>
  1058. <td>
  1059. <code>dataFrom</code></br>
  1060. <em>
  1061. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1062. []ExternalSecretDataRemoteRef
  1063. </a>
  1064. </em>
  1065. </td>
  1066. <td>
  1067. <em>(Optional)</em>
  1068. <p>DataFrom is used to fetch all properties from a specific Provider data
  1069. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1070. </td>
  1071. </tr>
  1072. </table>
  1073. </td>
  1074. </tr>
  1075. <tr>
  1076. <td>
  1077. <code>status</code></br>
  1078. <em>
  1079. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  1080. ExternalSecretStatus
  1081. </a>
  1082. </em>
  1083. </td>
  1084. <td>
  1085. </td>
  1086. </tr>
  1087. </tbody>
  1088. </table>
  1089. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  1090. (<code>string</code> alias)</p></h3>
  1091. <p>
  1092. (<em>Appears on:</em>
  1093. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  1094. </p>
  1095. <p>
  1096. </p>
  1097. <table>
  1098. <thead>
  1099. <tr>
  1100. <th>Value</th>
  1101. <th>Description</th>
  1102. </tr>
  1103. </thead>
  1104. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  1105. <td></td>
  1106. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1107. <td></td>
  1108. </tr></tbody>
  1109. </table>
  1110. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  1111. (<code>string</code> alias)</p></h3>
  1112. <p>
  1113. (<em>Appears on:</em>
  1114. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1115. </p>
  1116. <p>
  1117. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  1118. </p>
  1119. <table>
  1120. <thead>
  1121. <tr>
  1122. <th>Value</th>
  1123. <th>Description</th>
  1124. </tr>
  1125. </thead>
  1126. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  1127. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  1128. </td>
  1129. </tr><tr><td><p>&#34;None&#34;</p></td>
  1130. <td><p>None does not create a Secret (future use with injector).</p>
  1131. </td>
  1132. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  1133. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  1134. </td>
  1135. </tr></tbody>
  1136. </table>
  1137. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  1138. </h3>
  1139. <p>
  1140. (<em>Appears on:</em>
  1141. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1142. </p>
  1143. <p>
  1144. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  1145. </p>
  1146. <table>
  1147. <thead>
  1148. <tr>
  1149. <th>Field</th>
  1150. <th>Description</th>
  1151. </tr>
  1152. </thead>
  1153. <tbody>
  1154. <tr>
  1155. <td>
  1156. <code>secretKey</code></br>
  1157. <em>
  1158. string
  1159. </em>
  1160. </td>
  1161. <td>
  1162. </td>
  1163. </tr>
  1164. <tr>
  1165. <td>
  1166. <code>remoteRef</code></br>
  1167. <em>
  1168. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1169. ExternalSecretDataRemoteRef
  1170. </a>
  1171. </em>
  1172. </td>
  1173. <td>
  1174. </td>
  1175. </tr>
  1176. </tbody>
  1177. </table>
  1178. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  1179. </h3>
  1180. <p>
  1181. (<em>Appears on:</em>
  1182. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  1183. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1184. </p>
  1185. <p>
  1186. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  1187. </p>
  1188. <table>
  1189. <thead>
  1190. <tr>
  1191. <th>Field</th>
  1192. <th>Description</th>
  1193. </tr>
  1194. </thead>
  1195. <tbody>
  1196. <tr>
  1197. <td>
  1198. <code>key</code></br>
  1199. <em>
  1200. string
  1201. </em>
  1202. </td>
  1203. <td>
  1204. <p>Key is the key used in the Provider, mandatory</p>
  1205. </td>
  1206. </tr>
  1207. <tr>
  1208. <td>
  1209. <code>version</code></br>
  1210. <em>
  1211. string
  1212. </em>
  1213. </td>
  1214. <td>
  1215. <em>(Optional)</em>
  1216. <p>Used to select a specific version of the Provider value, if supported</p>
  1217. </td>
  1218. </tr>
  1219. <tr>
  1220. <td>
  1221. <code>property</code></br>
  1222. <em>
  1223. string
  1224. </em>
  1225. </td>
  1226. <td>
  1227. <em>(Optional)</em>
  1228. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  1229. </td>
  1230. </tr>
  1231. </tbody>
  1232. </table>
  1233. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  1234. </h3>
  1235. <p>
  1236. (<em>Appears on:</em>
  1237. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1238. </p>
  1239. <p>
  1240. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  1241. </p>
  1242. <table>
  1243. <thead>
  1244. <tr>
  1245. <th>Field</th>
  1246. <th>Description</th>
  1247. </tr>
  1248. </thead>
  1249. <tbody>
  1250. <tr>
  1251. <td>
  1252. <code>secretStoreRef</code></br>
  1253. <em>
  1254. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1255. SecretStoreRef
  1256. </a>
  1257. </em>
  1258. </td>
  1259. <td>
  1260. </td>
  1261. </tr>
  1262. <tr>
  1263. <td>
  1264. <code>target</code></br>
  1265. <em>
  1266. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1267. ExternalSecretTarget
  1268. </a>
  1269. </em>
  1270. </td>
  1271. <td>
  1272. </td>
  1273. </tr>
  1274. <tr>
  1275. <td>
  1276. <code>refreshInterval</code></br>
  1277. <em>
  1278. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1279. Kubernetes meta/v1.Duration
  1280. </a>
  1281. </em>
  1282. </td>
  1283. <td>
  1284. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1285. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  1286. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1287. </td>
  1288. </tr>
  1289. <tr>
  1290. <td>
  1291. <code>data</code></br>
  1292. <em>
  1293. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1294. []ExternalSecretData
  1295. </a>
  1296. </em>
  1297. </td>
  1298. <td>
  1299. <em>(Optional)</em>
  1300. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1301. </td>
  1302. </tr>
  1303. <tr>
  1304. <td>
  1305. <code>dataFrom</code></br>
  1306. <em>
  1307. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1308. []ExternalSecretDataRemoteRef
  1309. </a>
  1310. </em>
  1311. </td>
  1312. <td>
  1313. <em>(Optional)</em>
  1314. <p>DataFrom is used to fetch all properties from a specific Provider data
  1315. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1316. </td>
  1317. </tr>
  1318. </tbody>
  1319. </table>
  1320. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1321. </h3>
  1322. <p>
  1323. (<em>Appears on:</em>
  1324. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1325. </p>
  1326. <p>
  1327. </p>
  1328. <table>
  1329. <thead>
  1330. <tr>
  1331. <th>Field</th>
  1332. <th>Description</th>
  1333. </tr>
  1334. </thead>
  1335. <tbody>
  1336. <tr>
  1337. <td>
  1338. <code>refreshTime</code></br>
  1339. <em>
  1340. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1341. Kubernetes meta/v1.Time
  1342. </a>
  1343. </em>
  1344. </td>
  1345. <td>
  1346. <p>refreshTime is the time and date the external secret was fetched and
  1347. the target secret updated</p>
  1348. </td>
  1349. </tr>
  1350. <tr>
  1351. <td>
  1352. <code>syncedResourceVersion</code></br>
  1353. <em>
  1354. string
  1355. </em>
  1356. </td>
  1357. <td>
  1358. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1359. </td>
  1360. </tr>
  1361. <tr>
  1362. <td>
  1363. <code>conditions</code></br>
  1364. <em>
  1365. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1366. []ExternalSecretStatusCondition
  1367. </a>
  1368. </em>
  1369. </td>
  1370. <td>
  1371. <em>(Optional)</em>
  1372. </td>
  1373. </tr>
  1374. </tbody>
  1375. </table>
  1376. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1377. </h3>
  1378. <p>
  1379. (<em>Appears on:</em>
  1380. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1381. </p>
  1382. <p>
  1383. </p>
  1384. <table>
  1385. <thead>
  1386. <tr>
  1387. <th>Field</th>
  1388. <th>Description</th>
  1389. </tr>
  1390. </thead>
  1391. <tbody>
  1392. <tr>
  1393. <td>
  1394. <code>type</code></br>
  1395. <em>
  1396. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1397. ExternalSecretConditionType
  1398. </a>
  1399. </em>
  1400. </td>
  1401. <td>
  1402. </td>
  1403. </tr>
  1404. <tr>
  1405. <td>
  1406. <code>status</code></br>
  1407. <em>
  1408. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1409. Kubernetes core/v1.ConditionStatus
  1410. </a>
  1411. </em>
  1412. </td>
  1413. <td>
  1414. </td>
  1415. </tr>
  1416. <tr>
  1417. <td>
  1418. <code>reason</code></br>
  1419. <em>
  1420. string
  1421. </em>
  1422. </td>
  1423. <td>
  1424. <em>(Optional)</em>
  1425. </td>
  1426. </tr>
  1427. <tr>
  1428. <td>
  1429. <code>message</code></br>
  1430. <em>
  1431. string
  1432. </em>
  1433. </td>
  1434. <td>
  1435. <em>(Optional)</em>
  1436. </td>
  1437. </tr>
  1438. <tr>
  1439. <td>
  1440. <code>lastTransitionTime</code></br>
  1441. <em>
  1442. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1443. Kubernetes meta/v1.Time
  1444. </a>
  1445. </em>
  1446. </td>
  1447. <td>
  1448. <em>(Optional)</em>
  1449. </td>
  1450. </tr>
  1451. </tbody>
  1452. </table>
  1453. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1454. </h3>
  1455. <p>
  1456. (<em>Appears on:</em>
  1457. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1458. </p>
  1459. <p>
  1460. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1461. There can be only one target per ExternalSecret.</p>
  1462. </p>
  1463. <table>
  1464. <thead>
  1465. <tr>
  1466. <th>Field</th>
  1467. <th>Description</th>
  1468. </tr>
  1469. </thead>
  1470. <tbody>
  1471. <tr>
  1472. <td>
  1473. <code>name</code></br>
  1474. <em>
  1475. string
  1476. </em>
  1477. </td>
  1478. <td>
  1479. <em>(Optional)</em>
  1480. <p>Name defines the name of the Secret resource to be managed
  1481. This field is immutable
  1482. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1483. </td>
  1484. </tr>
  1485. <tr>
  1486. <td>
  1487. <code>creationPolicy</code></br>
  1488. <em>
  1489. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1490. ExternalSecretCreationPolicy
  1491. </a>
  1492. </em>
  1493. </td>
  1494. <td>
  1495. <em>(Optional)</em>
  1496. <p>CreationPolicy defines rules on how to create the resulting Secret
  1497. Defaults to &lsquo;Owner&rsquo;</p>
  1498. </td>
  1499. </tr>
  1500. <tr>
  1501. <td>
  1502. <code>template</code></br>
  1503. <em>
  1504. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  1505. ExternalSecretTemplate
  1506. </a>
  1507. </em>
  1508. </td>
  1509. <td>
  1510. <em>(Optional)</em>
  1511. <p>Template defines a blueprint for the created Secret resource.</p>
  1512. </td>
  1513. </tr>
  1514. </tbody>
  1515. </table>
  1516. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1517. </h3>
  1518. <p>
  1519. (<em>Appears on:</em>
  1520. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1521. </p>
  1522. <p>
  1523. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  1524. we can not use native corev1.Secret, it will have empty ObjectMeta values: <a href="https://github.com/kubernetes-sigs/controller-tools/issues/448">https://github.com/kubernetes-sigs/controller-tools/issues/448</a></p>
  1525. </p>
  1526. <table>
  1527. <thead>
  1528. <tr>
  1529. <th>Field</th>
  1530. <th>Description</th>
  1531. </tr>
  1532. </thead>
  1533. <tbody>
  1534. <tr>
  1535. <td>
  1536. <code>type</code></br>
  1537. <em>
  1538. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1539. Kubernetes core/v1.SecretType
  1540. </a>
  1541. </em>
  1542. </td>
  1543. <td>
  1544. <em>(Optional)</em>
  1545. </td>
  1546. </tr>
  1547. <tr>
  1548. <td>
  1549. <code>metadata</code></br>
  1550. <em>
  1551. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1552. ExternalSecretTemplateMetadata
  1553. </a>
  1554. </em>
  1555. </td>
  1556. <td>
  1557. <em>(Optional)</em>
  1558. </td>
  1559. </tr>
  1560. <tr>
  1561. <td>
  1562. <code>data</code></br>
  1563. <em>
  1564. map[string]string
  1565. </em>
  1566. </td>
  1567. <td>
  1568. <em>(Optional)</em>
  1569. </td>
  1570. </tr>
  1571. <tr>
  1572. <td>
  1573. <code>templateFrom</code></br>
  1574. <em>
  1575. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
  1576. []TemplateFrom
  1577. </a>
  1578. </em>
  1579. </td>
  1580. <td>
  1581. <em>(Optional)</em>
  1582. </td>
  1583. </tr>
  1584. </tbody>
  1585. </table>
  1586. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1587. </h3>
  1588. <p>
  1589. (<em>Appears on:</em>
  1590. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1591. </p>
  1592. <p>
  1593. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1594. </p>
  1595. <table>
  1596. <thead>
  1597. <tr>
  1598. <th>Field</th>
  1599. <th>Description</th>
  1600. </tr>
  1601. </thead>
  1602. <tbody>
  1603. <tr>
  1604. <td>
  1605. <code>annotations</code></br>
  1606. <em>
  1607. map[string]string
  1608. </em>
  1609. </td>
  1610. <td>
  1611. <em>(Optional)</em>
  1612. </td>
  1613. </tr>
  1614. <tr>
  1615. <td>
  1616. <code>labels</code></br>
  1617. <em>
  1618. map[string]string
  1619. </em>
  1620. </td>
  1621. <td>
  1622. <em>(Optional)</em>
  1623. </td>
  1624. </tr>
  1625. </tbody>
  1626. </table>
  1627. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  1628. </h3>
  1629. <p>
  1630. (<em>Appears on:</em>
  1631. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  1632. </p>
  1633. <p>
  1634. </p>
  1635. <table>
  1636. <thead>
  1637. <tr>
  1638. <th>Field</th>
  1639. <th>Description</th>
  1640. </tr>
  1641. </thead>
  1642. <tbody>
  1643. <tr>
  1644. <td>
  1645. <code>secretRef</code></br>
  1646. <em>
  1647. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  1648. GCPSMAuthSecretRef
  1649. </a>
  1650. </em>
  1651. </td>
  1652. <td>
  1653. </td>
  1654. </tr>
  1655. </tbody>
  1656. </table>
  1657. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  1658. </h3>
  1659. <p>
  1660. (<em>Appears on:</em>
  1661. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  1662. </p>
  1663. <p>
  1664. </p>
  1665. <table>
  1666. <thead>
  1667. <tr>
  1668. <th>Field</th>
  1669. <th>Description</th>
  1670. </tr>
  1671. </thead>
  1672. <tbody>
  1673. <tr>
  1674. <td>
  1675. <code>secretAccessKeySecretRef</code></br>
  1676. <em>
  1677. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1678. </em>
  1679. </td>
  1680. <td>
  1681. <em>(Optional)</em>
  1682. <p>The SecretAccessKey is used for authentication</p>
  1683. </td>
  1684. </tr>
  1685. </tbody>
  1686. </table>
  1687. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  1688. </h3>
  1689. <p>
  1690. (<em>Appears on:</em>
  1691. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1692. </p>
  1693. <p>
  1694. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  1695. </p>
  1696. <table>
  1697. <thead>
  1698. <tr>
  1699. <th>Field</th>
  1700. <th>Description</th>
  1701. </tr>
  1702. </thead>
  1703. <tbody>
  1704. <tr>
  1705. <td>
  1706. <code>auth</code></br>
  1707. <em>
  1708. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  1709. GCPSMAuth
  1710. </a>
  1711. </em>
  1712. </td>
  1713. <td>
  1714. <em>(Optional)</em>
  1715. <p>Auth defines the information necessary to authenticate against GCP</p>
  1716. </td>
  1717. </tr>
  1718. <tr>
  1719. <td>
  1720. <code>projectID</code></br>
  1721. <em>
  1722. string
  1723. </em>
  1724. </td>
  1725. <td>
  1726. <p>ProjectID project where secret is located</p>
  1727. </td>
  1728. </tr>
  1729. </tbody>
  1730. </table>
  1731. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1732. </h3>
  1733. <p>
  1734. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1735. or a namespaced SecretStore.</p>
  1736. </p>
  1737. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
  1738. </h3>
  1739. <p>
  1740. (<em>Appears on:</em>
  1741. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
  1742. </p>
  1743. <p>
  1744. </p>
  1745. <table>
  1746. <thead>
  1747. <tr>
  1748. <th>Field</th>
  1749. <th>Description</th>
  1750. </tr>
  1751. </thead>
  1752. <tbody>
  1753. <tr>
  1754. <td>
  1755. <code>SecretRef</code></br>
  1756. <em>
  1757. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
  1758. GitlabSecretRef
  1759. </a>
  1760. </em>
  1761. </td>
  1762. <td>
  1763. </td>
  1764. </tr>
  1765. </tbody>
  1766. </table>
  1767. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
  1768. </h3>
  1769. <p>
  1770. (<em>Appears on:</em>
  1771. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1772. </p>
  1773. <p>
  1774. <p>Configures a store to sync secrets with a GitLab instance.</p>
  1775. </p>
  1776. <table>
  1777. <thead>
  1778. <tr>
  1779. <th>Field</th>
  1780. <th>Description</th>
  1781. </tr>
  1782. </thead>
  1783. <tbody>
  1784. <tr>
  1785. <td>
  1786. <code>url</code></br>
  1787. <em>
  1788. string
  1789. </em>
  1790. </td>
  1791. <td>
  1792. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  1793. </td>
  1794. </tr>
  1795. <tr>
  1796. <td>
  1797. <code>auth</code></br>
  1798. <em>
  1799. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
  1800. GitlabAuth
  1801. </a>
  1802. </em>
  1803. </td>
  1804. <td>
  1805. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  1806. </td>
  1807. </tr>
  1808. <tr>
  1809. <td>
  1810. <code>projectID</code></br>
  1811. <em>
  1812. string
  1813. </em>
  1814. </td>
  1815. <td>
  1816. <p>ProjectID specifies a project where secrets are located.</p>
  1817. </td>
  1818. </tr>
  1819. </tbody>
  1820. </table>
  1821. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
  1822. </h3>
  1823. <p>
  1824. (<em>Appears on:</em>
  1825. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
  1826. </p>
  1827. <p>
  1828. </p>
  1829. <table>
  1830. <thead>
  1831. <tr>
  1832. <th>Field</th>
  1833. <th>Description</th>
  1834. </tr>
  1835. </thead>
  1836. <tbody>
  1837. <tr>
  1838. <td>
  1839. <code>accessToken</code></br>
  1840. <em>
  1841. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1842. </em>
  1843. </td>
  1844. <td>
  1845. <p>AccessToken is used for authentication.</p>
  1846. </td>
  1847. </tr>
  1848. </tbody>
  1849. </table>
  1850. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
  1851. </h3>
  1852. <p>
  1853. (<em>Appears on:</em>
  1854. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
  1855. </p>
  1856. <p>
  1857. </p>
  1858. <table>
  1859. <thead>
  1860. <tr>
  1861. <th>Field</th>
  1862. <th>Description</th>
  1863. </tr>
  1864. </thead>
  1865. <tbody>
  1866. <tr>
  1867. <td>
  1868. <code>secretRef</code></br>
  1869. <em>
  1870. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
  1871. IBMAuthSecretRef
  1872. </a>
  1873. </em>
  1874. </td>
  1875. <td>
  1876. </td>
  1877. </tr>
  1878. </tbody>
  1879. </table>
  1880. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
  1881. </h3>
  1882. <p>
  1883. (<em>Appears on:</em>
  1884. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
  1885. </p>
  1886. <p>
  1887. </p>
  1888. <table>
  1889. <thead>
  1890. <tr>
  1891. <th>Field</th>
  1892. <th>Description</th>
  1893. </tr>
  1894. </thead>
  1895. <tbody>
  1896. <tr>
  1897. <td>
  1898. <code>secretApiKeySecretRef</code></br>
  1899. <em>
  1900. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1901. </em>
  1902. </td>
  1903. <td>
  1904. <em>(Optional)</em>
  1905. <p>The SecretAccessKey is used for authentication</p>
  1906. </td>
  1907. </tr>
  1908. </tbody>
  1909. </table>
  1910. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
  1911. </h3>
  1912. <p>
  1913. (<em>Appears on:</em>
  1914. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1915. </p>
  1916. <p>
  1917. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  1918. backend.</p>
  1919. </p>
  1920. <table>
  1921. <thead>
  1922. <tr>
  1923. <th>Field</th>
  1924. <th>Description</th>
  1925. </tr>
  1926. </thead>
  1927. <tbody>
  1928. <tr>
  1929. <td>
  1930. <code>auth</code></br>
  1931. <em>
  1932. <a href="#external-secrets.io/v1alpha1.IBMAuth">
  1933. IBMAuth
  1934. </a>
  1935. </em>
  1936. </td>
  1937. <td>
  1938. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  1939. </td>
  1940. </tr>
  1941. <tr>
  1942. <td>
  1943. <code>serviceUrl</code></br>
  1944. <em>
  1945. string
  1946. </em>
  1947. </td>
  1948. <td>
  1949. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  1950. </td>
  1951. </tr>
  1952. </tbody>
  1953. </table>
  1954. <h3 id="external-secrets.io/v1alpha1.OracleAuth">OracleAuth
  1955. </h3>
  1956. <p>
  1957. (<em>Appears on:</em>
  1958. <a href="#external-secrets.io/v1alpha1.OracleProvider">OracleProvider</a>)
  1959. </p>
  1960. <p>
  1961. </p>
  1962. <table>
  1963. <thead>
  1964. <tr>
  1965. <th>Field</th>
  1966. <th>Description</th>
  1967. </tr>
  1968. </thead>
  1969. <tbody>
  1970. <tr>
  1971. <td>
  1972. <code>secretRef</code></br>
  1973. <em>
  1974. <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
  1975. OracleSecretRef
  1976. </a>
  1977. </em>
  1978. </td>
  1979. <td>
  1980. <p>SecretRef to pass through sensitive information.</p>
  1981. </td>
  1982. </tr>
  1983. </tbody>
  1984. </table>
  1985. <h3 id="external-secrets.io/v1alpha1.OracleProvider">OracleProvider
  1986. </h3>
  1987. <p>
  1988. (<em>Appears on:</em>
  1989. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1990. </p>
  1991. <p>
  1992. <p>Configures an store to sync secrets using a Oracle Vault
  1993. backend.</p>
  1994. </p>
  1995. <table>
  1996. <thead>
  1997. <tr>
  1998. <th>Field</th>
  1999. <th>Description</th>
  2000. </tr>
  2001. </thead>
  2002. <tbody>
  2003. <tr>
  2004. <td>
  2005. <code>auth</code></br>
  2006. <em>
  2007. <a href="#external-secrets.io/v1alpha1.OracleAuth">
  2008. OracleAuth
  2009. </a>
  2010. </em>
  2011. </td>
  2012. <td>
  2013. <p>Auth configures how secret-manager authenticates with the Oracle Vault.</p>
  2014. </td>
  2015. </tr>
  2016. <tr>
  2017. <td>
  2018. <code>user</code></br>
  2019. <em>
  2020. string
  2021. </em>
  2022. </td>
  2023. <td>
  2024. <p>User is an access OCID specific to the account.</p>
  2025. </td>
  2026. </tr>
  2027. <tr>
  2028. <td>
  2029. <code>tenancy</code></br>
  2030. <em>
  2031. string
  2032. </em>
  2033. </td>
  2034. <td>
  2035. <p>projectID is an access token specific to the secret.</p>
  2036. </td>
  2037. </tr>
  2038. <tr>
  2039. <td>
  2040. <code>region</code></br>
  2041. <em>
  2042. string
  2043. </em>
  2044. </td>
  2045. <td>
  2046. <p>projectID is an access token specific to the secret.</p>
  2047. </td>
  2048. </tr>
  2049. </tbody>
  2050. </table>
  2051. <h3 id="external-secrets.io/v1alpha1.OracleSecretRef">OracleSecretRef
  2052. </h3>
  2053. <p>
  2054. (<em>Appears on:</em>
  2055. <a href="#external-secrets.io/v1alpha1.OracleAuth">OracleAuth</a>)
  2056. </p>
  2057. <p>
  2058. </p>
  2059. <table>
  2060. <thead>
  2061. <tr>
  2062. <th>Field</th>
  2063. <th>Description</th>
  2064. </tr>
  2065. </thead>
  2066. <tbody>
  2067. <tr>
  2068. <td>
  2069. <code>privatekey</code></br>
  2070. <em>
  2071. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2072. </em>
  2073. </td>
  2074. <td>
  2075. <p>The Access Token is used for authentication</p>
  2076. </td>
  2077. </tr>
  2078. <tr>
  2079. <td>
  2080. <code>fingerprint</code></br>
  2081. <em>
  2082. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2083. </em>
  2084. </td>
  2085. <td>
  2086. <p>projectID is an access token specific to the secret.</p>
  2087. </td>
  2088. </tr>
  2089. </tbody>
  2090. </table>
  2091. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  2092. </h3>
  2093. <p>
  2094. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2095. </p>
  2096. <table>
  2097. <thead>
  2098. <tr>
  2099. <th>Field</th>
  2100. <th>Description</th>
  2101. </tr>
  2102. </thead>
  2103. <tbody>
  2104. <tr>
  2105. <td>
  2106. <code>metadata</code></br>
  2107. <em>
  2108. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  2109. Kubernetes meta/v1.ObjectMeta
  2110. </a>
  2111. </em>
  2112. </td>
  2113. <td>
  2114. Refer to the Kubernetes API documentation for the fields of the
  2115. <code>metadata</code> field.
  2116. </td>
  2117. </tr>
  2118. <tr>
  2119. <td>
  2120. <code>spec</code></br>
  2121. <em>
  2122. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  2123. SecretStoreSpec
  2124. </a>
  2125. </em>
  2126. </td>
  2127. <td>
  2128. <br/>
  2129. <br/>
  2130. <table>
  2131. <tr>
  2132. <td>
  2133. <code>controller</code></br>
  2134. <em>
  2135. string
  2136. </em>
  2137. </td>
  2138. <td>
  2139. <em>(Optional)</em>
  2140. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2141. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2142. </td>
  2143. </tr>
  2144. <tr>
  2145. <td>
  2146. <code>provider</code></br>
  2147. <em>
  2148. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2149. SecretStoreProvider
  2150. </a>
  2151. </em>
  2152. </td>
  2153. <td>
  2154. <p>Used to configure the provider. Only one provider may be set</p>
  2155. </td>
  2156. </tr>
  2157. </table>
  2158. </td>
  2159. </tr>
  2160. <tr>
  2161. <td>
  2162. <code>status</code></br>
  2163. <em>
  2164. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  2165. SecretStoreStatus
  2166. </a>
  2167. </em>
  2168. </td>
  2169. <td>
  2170. </td>
  2171. </tr>
  2172. </tbody>
  2173. </table>
  2174. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  2175. (<code>string</code> alias)</p></h3>
  2176. <p>
  2177. (<em>Appears on:</em>
  2178. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  2179. </p>
  2180. <p>
  2181. </p>
  2182. <table>
  2183. <thead>
  2184. <tr>
  2185. <th>Value</th>
  2186. <th>Description</th>
  2187. </tr>
  2188. </thead>
  2189. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2190. <td></td>
  2191. </tr></tbody>
  2192. </table>
  2193. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  2194. </h3>
  2195. <p>
  2196. (<em>Appears on:</em>
  2197. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  2198. </p>
  2199. <p>
  2200. <p>SecretStoreProvider contains the provider-specific configration.</p>
  2201. </p>
  2202. <table>
  2203. <thead>
  2204. <tr>
  2205. <th>Field</th>
  2206. <th>Description</th>
  2207. </tr>
  2208. </thead>
  2209. <tbody>
  2210. <tr>
  2211. <td>
  2212. <code>aws</code></br>
  2213. <em>
  2214. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  2215. AWSProvider
  2216. </a>
  2217. </em>
  2218. </td>
  2219. <td>
  2220. <em>(Optional)</em>
  2221. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  2222. </td>
  2223. </tr>
  2224. <tr>
  2225. <td>
  2226. <code>azurekv</code></br>
  2227. <em>
  2228. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  2229. AzureKVProvider
  2230. </a>
  2231. </em>
  2232. </td>
  2233. <td>
  2234. <em>(Optional)</em>
  2235. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  2236. </td>
  2237. </tr>
  2238. <tr>
  2239. <td>
  2240. <code>vault</code></br>
  2241. <em>
  2242. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  2243. VaultProvider
  2244. </a>
  2245. </em>
  2246. </td>
  2247. <td>
  2248. <em>(Optional)</em>
  2249. <p>Vault configures this store to sync secrets using Hashi provider</p>
  2250. </td>
  2251. </tr>
  2252. <tr>
  2253. <td>
  2254. <code>gcpsm</code></br>
  2255. <em>
  2256. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  2257. GCPSMProvider
  2258. </a>
  2259. </em>
  2260. </td>
  2261. <td>
  2262. <em>(Optional)</em>
  2263. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  2264. </td>
  2265. </tr>
  2266. <tr>
  2267. <td>
  2268. <code>oracle</code></br>
  2269. <em>
  2270. <a href="#external-secrets.io/v1alpha1.OracleProvider">
  2271. OracleProvider
  2272. </a>
  2273. </em>
  2274. </td>
  2275. <td>
  2276. <em>(Optional)</em>
  2277. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  2278. </td>
  2279. </tr>
  2280. <tr>
  2281. <td>
  2282. <code>ibm</code></br>
  2283. <em>
  2284. <a href="#external-secrets.io/v1alpha1.IBMProvider">
  2285. IBMProvider
  2286. </a>
  2287. </em>
  2288. </td>
  2289. <td>
  2290. <em>(Optional)</em>
  2291. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  2292. </td>
  2293. </tr>
  2294. <tr>
  2295. <td>
  2296. <code>yandexlockbox</code></br>
  2297. <em>
  2298. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
  2299. YandexLockboxProvider
  2300. </a>
  2301. </em>
  2302. </td>
  2303. <td>
  2304. <em>(Optional)</em>
  2305. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  2306. </td>
  2307. </tr>
  2308. <tr>
  2309. <td>
  2310. <code>gitlab</code></br>
  2311. <em>
  2312. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
  2313. GitlabProvider
  2314. </a>
  2315. </em>
  2316. </td>
  2317. <td>
  2318. <em>(Optional)</em>
  2319. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  2320. </td>
  2321. </tr>
  2322. <tr>
  2323. <td>
  2324. <code>alibaba</code></br>
  2325. <em>
  2326. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">
  2327. AlibabaProvider
  2328. </a>
  2329. </em>
  2330. </td>
  2331. <td>
  2332. <em>(Optional)</em>
  2333. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  2334. </td>
  2335. </tr>
  2336. </tbody>
  2337. </table>
  2338. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  2339. </h3>
  2340. <p>
  2341. (<em>Appears on:</em>
  2342. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2343. </p>
  2344. <p>
  2345. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  2346. </p>
  2347. <table>
  2348. <thead>
  2349. <tr>
  2350. <th>Field</th>
  2351. <th>Description</th>
  2352. </tr>
  2353. </thead>
  2354. <tbody>
  2355. <tr>
  2356. <td>
  2357. <code>name</code></br>
  2358. <em>
  2359. string
  2360. </em>
  2361. </td>
  2362. <td>
  2363. <p>Name of the SecretStore resource</p>
  2364. </td>
  2365. </tr>
  2366. <tr>
  2367. <td>
  2368. <code>kind</code></br>
  2369. <em>
  2370. string
  2371. </em>
  2372. </td>
  2373. <td>
  2374. <em>(Optional)</em>
  2375. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  2376. Defaults to <code>SecretStore</code></p>
  2377. </td>
  2378. </tr>
  2379. </tbody>
  2380. </table>
  2381. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  2382. </h3>
  2383. <p>
  2384. (<em>Appears on:</em>
  2385. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2386. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2387. </p>
  2388. <p>
  2389. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  2390. </p>
  2391. <table>
  2392. <thead>
  2393. <tr>
  2394. <th>Field</th>
  2395. <th>Description</th>
  2396. </tr>
  2397. </thead>
  2398. <tbody>
  2399. <tr>
  2400. <td>
  2401. <code>controller</code></br>
  2402. <em>
  2403. string
  2404. </em>
  2405. </td>
  2406. <td>
  2407. <em>(Optional)</em>
  2408. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2409. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2410. </td>
  2411. </tr>
  2412. <tr>
  2413. <td>
  2414. <code>provider</code></br>
  2415. <em>
  2416. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2417. SecretStoreProvider
  2418. </a>
  2419. </em>
  2420. </td>
  2421. <td>
  2422. <p>Used to configure the provider. Only one provider may be set</p>
  2423. </td>
  2424. </tr>
  2425. </tbody>
  2426. </table>
  2427. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  2428. </h3>
  2429. <p>
  2430. (<em>Appears on:</em>
  2431. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2432. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2433. </p>
  2434. <p>
  2435. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  2436. </p>
  2437. <table>
  2438. <thead>
  2439. <tr>
  2440. <th>Field</th>
  2441. <th>Description</th>
  2442. </tr>
  2443. </thead>
  2444. <tbody>
  2445. <tr>
  2446. <td>
  2447. <code>conditions</code></br>
  2448. <em>
  2449. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  2450. []SecretStoreStatusCondition
  2451. </a>
  2452. </em>
  2453. </td>
  2454. <td>
  2455. <em>(Optional)</em>
  2456. </td>
  2457. </tr>
  2458. </tbody>
  2459. </table>
  2460. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  2461. </h3>
  2462. <p>
  2463. (<em>Appears on:</em>
  2464. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  2465. </p>
  2466. <p>
  2467. </p>
  2468. <table>
  2469. <thead>
  2470. <tr>
  2471. <th>Field</th>
  2472. <th>Description</th>
  2473. </tr>
  2474. </thead>
  2475. <tbody>
  2476. <tr>
  2477. <td>
  2478. <code>type</code></br>
  2479. <em>
  2480. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  2481. SecretStoreConditionType
  2482. </a>
  2483. </em>
  2484. </td>
  2485. <td>
  2486. </td>
  2487. </tr>
  2488. <tr>
  2489. <td>
  2490. <code>status</code></br>
  2491. <em>
  2492. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2493. Kubernetes core/v1.ConditionStatus
  2494. </a>
  2495. </em>
  2496. </td>
  2497. <td>
  2498. </td>
  2499. </tr>
  2500. <tr>
  2501. <td>
  2502. <code>reason</code></br>
  2503. <em>
  2504. string
  2505. </em>
  2506. </td>
  2507. <td>
  2508. <em>(Optional)</em>
  2509. </td>
  2510. </tr>
  2511. <tr>
  2512. <td>
  2513. <code>message</code></br>
  2514. <em>
  2515. string
  2516. </em>
  2517. </td>
  2518. <td>
  2519. <em>(Optional)</em>
  2520. </td>
  2521. </tr>
  2522. <tr>
  2523. <td>
  2524. <code>lastTransitionTime</code></br>
  2525. <em>
  2526. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2527. Kubernetes meta/v1.Time
  2528. </a>
  2529. </em>
  2530. </td>
  2531. <td>
  2532. <em>(Optional)</em>
  2533. </td>
  2534. </tr>
  2535. </tbody>
  2536. </table>
  2537. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
  2538. </h3>
  2539. <p>
  2540. (<em>Appears on:</em>
  2541. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2542. </p>
  2543. <p>
  2544. </p>
  2545. <table>
  2546. <thead>
  2547. <tr>
  2548. <th>Field</th>
  2549. <th>Description</th>
  2550. </tr>
  2551. </thead>
  2552. <tbody>
  2553. <tr>
  2554. <td>
  2555. <code>configMap</code></br>
  2556. <em>
  2557. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2558. TemplateRef
  2559. </a>
  2560. </em>
  2561. </td>
  2562. <td>
  2563. </td>
  2564. </tr>
  2565. <tr>
  2566. <td>
  2567. <code>secret</code></br>
  2568. <em>
  2569. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2570. TemplateRef
  2571. </a>
  2572. </em>
  2573. </td>
  2574. <td>
  2575. </td>
  2576. </tr>
  2577. </tbody>
  2578. </table>
  2579. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
  2580. </h3>
  2581. <p>
  2582. (<em>Appears on:</em>
  2583. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
  2584. </p>
  2585. <p>
  2586. </p>
  2587. <table>
  2588. <thead>
  2589. <tr>
  2590. <th>Field</th>
  2591. <th>Description</th>
  2592. </tr>
  2593. </thead>
  2594. <tbody>
  2595. <tr>
  2596. <td>
  2597. <code>name</code></br>
  2598. <em>
  2599. string
  2600. </em>
  2601. </td>
  2602. <td>
  2603. </td>
  2604. </tr>
  2605. <tr>
  2606. <td>
  2607. <code>items</code></br>
  2608. <em>
  2609. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
  2610. []TemplateRefItem
  2611. </a>
  2612. </em>
  2613. </td>
  2614. <td>
  2615. </td>
  2616. </tr>
  2617. </tbody>
  2618. </table>
  2619. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
  2620. </h3>
  2621. <p>
  2622. (<em>Appears on:</em>
  2623. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
  2624. </p>
  2625. <p>
  2626. </p>
  2627. <table>
  2628. <thead>
  2629. <tr>
  2630. <th>Field</th>
  2631. <th>Description</th>
  2632. </tr>
  2633. </thead>
  2634. <tbody>
  2635. <tr>
  2636. <td>
  2637. <code>key</code></br>
  2638. <em>
  2639. string
  2640. </em>
  2641. </td>
  2642. <td>
  2643. </td>
  2644. </tr>
  2645. </tbody>
  2646. </table>
  2647. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  2648. </h3>
  2649. <p>
  2650. (<em>Appears on:</em>
  2651. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2652. </p>
  2653. <p>
  2654. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  2655. with the role and secret stored in a Kubernetes Secret resource.</p>
  2656. </p>
  2657. <table>
  2658. <thead>
  2659. <tr>
  2660. <th>Field</th>
  2661. <th>Description</th>
  2662. </tr>
  2663. </thead>
  2664. <tbody>
  2665. <tr>
  2666. <td>
  2667. <code>path</code></br>
  2668. <em>
  2669. string
  2670. </em>
  2671. </td>
  2672. <td>
  2673. <p>Path where the App Role authentication backend is mounted
  2674. in Vault, e.g: &ldquo;approle&rdquo;</p>
  2675. </td>
  2676. </tr>
  2677. <tr>
  2678. <td>
  2679. <code>roleId</code></br>
  2680. <em>
  2681. string
  2682. </em>
  2683. </td>
  2684. <td>
  2685. <p>RoleID configured in the App Role authentication backend when setting
  2686. up the authentication backend in Vault.</p>
  2687. </td>
  2688. </tr>
  2689. <tr>
  2690. <td>
  2691. <code>secretRef</code></br>
  2692. <em>
  2693. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2694. </em>
  2695. </td>
  2696. <td>
  2697. <p>Reference to a key in a Secret that contains the App Role secret used
  2698. to authenticate with Vault.
  2699. The <code>key</code> field must be specified and denotes which entry within the Secret
  2700. resource is used as the app role secret.</p>
  2701. </td>
  2702. </tr>
  2703. </tbody>
  2704. </table>
  2705. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  2706. </h3>
  2707. <p>
  2708. (<em>Appears on:</em>
  2709. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2710. </p>
  2711. <p>
  2712. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  2713. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  2714. can be specified.</p>
  2715. </p>
  2716. <table>
  2717. <thead>
  2718. <tr>
  2719. <th>Field</th>
  2720. <th>Description</th>
  2721. </tr>
  2722. </thead>
  2723. <tbody>
  2724. <tr>
  2725. <td>
  2726. <code>tokenSecretRef</code></br>
  2727. <em>
  2728. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2729. </em>
  2730. </td>
  2731. <td>
  2732. <em>(Optional)</em>
  2733. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  2734. </td>
  2735. </tr>
  2736. <tr>
  2737. <td>
  2738. <code>appRole</code></br>
  2739. <em>
  2740. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  2741. VaultAppRole
  2742. </a>
  2743. </em>
  2744. </td>
  2745. <td>
  2746. <em>(Optional)</em>
  2747. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  2748. with the role and secret stored in a Kubernetes Secret resource.</p>
  2749. </td>
  2750. </tr>
  2751. <tr>
  2752. <td>
  2753. <code>kubernetes</code></br>
  2754. <em>
  2755. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  2756. VaultKubernetesAuth
  2757. </a>
  2758. </em>
  2759. </td>
  2760. <td>
  2761. <em>(Optional)</em>
  2762. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  2763. token stored in the named Secret resource to the Vault server.</p>
  2764. </td>
  2765. </tr>
  2766. <tr>
  2767. <td>
  2768. <code>ldap</code></br>
  2769. <em>
  2770. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  2771. VaultLdapAuth
  2772. </a>
  2773. </em>
  2774. </td>
  2775. <td>
  2776. <em>(Optional)</em>
  2777. <p>Ldap authenticates with Vault by passing username/password pair using
  2778. the LDAP authentication method</p>
  2779. </td>
  2780. </tr>
  2781. <tr>
  2782. <td>
  2783. <code>jwt</code></br>
  2784. <em>
  2785. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  2786. VaultJwtAuth
  2787. </a>
  2788. </em>
  2789. </td>
  2790. <td>
  2791. <em>(Optional)</em>
  2792. <p>Jwt authenticates with Vault by passing role and JWT token using the
  2793. JWT/OIDC authentication method</p>
  2794. </td>
  2795. </tr>
  2796. <tr>
  2797. <td>
  2798. <code>cert</code></br>
  2799. <em>
  2800. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
  2801. VaultCertAuth
  2802. </a>
  2803. </em>
  2804. </td>
  2805. <td>
  2806. <em>(Optional)</em>
  2807. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  2808. Cert authentication method</p>
  2809. </td>
  2810. </tr>
  2811. </tbody>
  2812. </table>
  2813. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
  2814. </h3>
  2815. <p>
  2816. (<em>Appears on:</em>
  2817. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2818. </p>
  2819. <p>
  2820. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  2821. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  2822. </p>
  2823. <table>
  2824. <thead>
  2825. <tr>
  2826. <th>Field</th>
  2827. <th>Description</th>
  2828. </tr>
  2829. </thead>
  2830. <tbody>
  2831. <tr>
  2832. <td>
  2833. <code>clientCert</code></br>
  2834. <em>
  2835. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2836. </em>
  2837. </td>
  2838. <td>
  2839. <em>(Optional)</em>
  2840. <p>ClientCert is a certificate to authenticate using the Cert Vault
  2841. authentication method</p>
  2842. </td>
  2843. </tr>
  2844. <tr>
  2845. <td>
  2846. <code>secretRef</code></br>
  2847. <em>
  2848. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2849. </em>
  2850. </td>
  2851. <td>
  2852. <p>SecretRef to a key in a Secret resource containing client private key to
  2853. authenticate with Vault using the Cert authentication method</p>
  2854. </td>
  2855. </tr>
  2856. </tbody>
  2857. </table>
  2858. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  2859. </h3>
  2860. <p>
  2861. (<em>Appears on:</em>
  2862. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2863. </p>
  2864. <p>
  2865. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  2866. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  2867. </p>
  2868. <table>
  2869. <thead>
  2870. <tr>
  2871. <th>Field</th>
  2872. <th>Description</th>
  2873. </tr>
  2874. </thead>
  2875. <tbody>
  2876. <tr>
  2877. <td>
  2878. <code>role</code></br>
  2879. <em>
  2880. string
  2881. </em>
  2882. </td>
  2883. <td>
  2884. <em>(Optional)</em>
  2885. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  2886. authentication method</p>
  2887. </td>
  2888. </tr>
  2889. <tr>
  2890. <td>
  2891. <code>secretRef</code></br>
  2892. <em>
  2893. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2894. </em>
  2895. </td>
  2896. <td>
  2897. <p>SecretRef to a key in a Secret resource containing JWT token to
  2898. authenticate with Vault using the JWT/OIDC authentication method</p>
  2899. </td>
  2900. </tr>
  2901. </tbody>
  2902. </table>
  2903. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  2904. (<code>string</code> alias)</p></h3>
  2905. <p>
  2906. (<em>Appears on:</em>
  2907. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2908. </p>
  2909. <p>
  2910. </p>
  2911. <table>
  2912. <thead>
  2913. <tr>
  2914. <th>Value</th>
  2915. <th>Description</th>
  2916. </tr>
  2917. </thead>
  2918. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  2919. <td></td>
  2920. </tr><tr><td><p>&#34;v2&#34;</p></td>
  2921. <td></td>
  2922. </tr></tbody>
  2923. </table>
  2924. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  2925. </h3>
  2926. <p>
  2927. (<em>Appears on:</em>
  2928. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2929. </p>
  2930. <p>
  2931. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  2932. a Secret.</p>
  2933. </p>
  2934. <table>
  2935. <thead>
  2936. <tr>
  2937. <th>Field</th>
  2938. <th>Description</th>
  2939. </tr>
  2940. </thead>
  2941. <tbody>
  2942. <tr>
  2943. <td>
  2944. <code>mountPath</code></br>
  2945. <em>
  2946. string
  2947. </em>
  2948. </td>
  2949. <td>
  2950. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  2951. &ldquo;kubernetes&rdquo;</p>
  2952. </td>
  2953. </tr>
  2954. <tr>
  2955. <td>
  2956. <code>serviceAccountRef</code></br>
  2957. <em>
  2958. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  2959. </em>
  2960. </td>
  2961. <td>
  2962. <em>(Optional)</em>
  2963. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  2964. If the service account is specified, the service account secret token JWT will be used
  2965. for authenticating with Vault. If the service account selector is not supplied,
  2966. the secretRef will be used instead.</p>
  2967. </td>
  2968. </tr>
  2969. <tr>
  2970. <td>
  2971. <code>secretRef</code></br>
  2972. <em>
  2973. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2974. </em>
  2975. </td>
  2976. <td>
  2977. <em>(Optional)</em>
  2978. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  2979. for authenticating with Vault. If a name is specified without a key,
  2980. <code>token</code> is the default. If one is not specified, the one bound to
  2981. the controller will be used.</p>
  2982. </td>
  2983. </tr>
  2984. <tr>
  2985. <td>
  2986. <code>role</code></br>
  2987. <em>
  2988. string
  2989. </em>
  2990. </td>
  2991. <td>
  2992. <p>A required field containing the Vault Role to assume. A Role binds a
  2993. Kubernetes ServiceAccount with a set of Vault policies.</p>
  2994. </td>
  2995. </tr>
  2996. </tbody>
  2997. </table>
  2998. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  2999. </h3>
  3000. <p>
  3001. (<em>Appears on:</em>
  3002. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3003. </p>
  3004. <p>
  3005. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  3006. with the username and password stored in a Kubernetes Secret resource.</p>
  3007. </p>
  3008. <table>
  3009. <thead>
  3010. <tr>
  3011. <th>Field</th>
  3012. <th>Description</th>
  3013. </tr>
  3014. </thead>
  3015. <tbody>
  3016. <tr>
  3017. <td>
  3018. <code>username</code></br>
  3019. <em>
  3020. string
  3021. </em>
  3022. </td>
  3023. <td>
  3024. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  3025. authentication method</p>
  3026. </td>
  3027. </tr>
  3028. <tr>
  3029. <td>
  3030. <code>secretRef</code></br>
  3031. <em>
  3032. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3033. </em>
  3034. </td>
  3035. <td>
  3036. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  3037. user used to authenticate with Vault using the LDAP authentication
  3038. method</p>
  3039. </td>
  3040. </tr>
  3041. </tbody>
  3042. </table>
  3043. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  3044. </h3>
  3045. <p>
  3046. (<em>Appears on:</em>
  3047. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3048. </p>
  3049. <p>
  3050. <p>Configures an store to sync secrets using a HashiCorp Vault
  3051. KV backend.</p>
  3052. </p>
  3053. <table>
  3054. <thead>
  3055. <tr>
  3056. <th>Field</th>
  3057. <th>Description</th>
  3058. </tr>
  3059. </thead>
  3060. <tbody>
  3061. <tr>
  3062. <td>
  3063. <code>auth</code></br>
  3064. <em>
  3065. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  3066. VaultAuth
  3067. </a>
  3068. </em>
  3069. </td>
  3070. <td>
  3071. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  3072. </td>
  3073. </tr>
  3074. <tr>
  3075. <td>
  3076. <code>server</code></br>
  3077. <em>
  3078. string
  3079. </em>
  3080. </td>
  3081. <td>
  3082. <p>Server is the connection address for the Vault server, e.g: &ldquo;<a href="https://vault.example.com:8200&quot;">https://vault.example.com:8200&rdquo;</a>.</p>
  3083. </td>
  3084. </tr>
  3085. <tr>
  3086. <td>
  3087. <code>path</code></br>
  3088. <em>
  3089. string
  3090. </em>
  3091. </td>
  3092. <td>
  3093. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  3094. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  3095. for fetching secrets from Vault is optional and will be appended
  3096. if not present in specified path.</p>
  3097. </td>
  3098. </tr>
  3099. <tr>
  3100. <td>
  3101. <code>version</code></br>
  3102. <em>
  3103. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  3104. VaultKVStoreVersion
  3105. </a>
  3106. </em>
  3107. </td>
  3108. <td>
  3109. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  3110. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  3111. </td>
  3112. </tr>
  3113. <tr>
  3114. <td>
  3115. <code>namespace</code></br>
  3116. <em>
  3117. string
  3118. </em>
  3119. </td>
  3120. <td>
  3121. <em>(Optional)</em>
  3122. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  3123. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  3124. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a></p>
  3125. </td>
  3126. </tr>
  3127. <tr>
  3128. <td>
  3129. <code>caBundle</code></br>
  3130. <em>
  3131. []byte
  3132. </em>
  3133. </td>
  3134. <td>
  3135. <em>(Optional)</em>
  3136. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  3137. if the Server URL is using HTTPS protocol. This parameter is ignored for
  3138. plain HTTP protocol connection. If not set the system root certificates
  3139. are used to validate the TLS connection.</p>
  3140. </td>
  3141. </tr>
  3142. </tbody>
  3143. </table>
  3144. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
  3145. </h3>
  3146. <p>
  3147. (<em>Appears on:</em>
  3148. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  3149. </p>
  3150. <p>
  3151. </p>
  3152. <table>
  3153. <thead>
  3154. <tr>
  3155. <th>Field</th>
  3156. <th>Description</th>
  3157. </tr>
  3158. </thead>
  3159. <tbody>
  3160. <tr>
  3161. <td>
  3162. <code>authorizedKeySecretRef</code></br>
  3163. <em>
  3164. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3165. </em>
  3166. </td>
  3167. <td>
  3168. <em>(Optional)</em>
  3169. <p>The authorized key used for authentication</p>
  3170. </td>
  3171. </tr>
  3172. </tbody>
  3173. </table>
  3174. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
  3175. </h3>
  3176. <p>
  3177. (<em>Appears on:</em>
  3178. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3179. </p>
  3180. <p>
  3181. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  3182. </p>
  3183. <table>
  3184. <thead>
  3185. <tr>
  3186. <th>Field</th>
  3187. <th>Description</th>
  3188. </tr>
  3189. </thead>
  3190. <tbody>
  3191. <tr>
  3192. <td>
  3193. <code>apiEndpoint</code></br>
  3194. <em>
  3195. string
  3196. </em>
  3197. </td>
  3198. <td>
  3199. <em>(Optional)</em>
  3200. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  3201. </td>
  3202. </tr>
  3203. <tr>
  3204. <td>
  3205. <code>auth</code></br>
  3206. <em>
  3207. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
  3208. YandexLockboxAuth
  3209. </a>
  3210. </em>
  3211. </td>
  3212. <td>
  3213. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  3214. </td>
  3215. </tr>
  3216. </tbody>
  3217. </table>
  3218. <hr/>
  3219. <p><em>
  3220. Generated with <code>gen-crd-api-reference-docs</code>.
  3221. </em></p></p>
  3222. </article>
  3223. </div>
  3224. </div>
  3225. </main>
  3226. <footer class="md-footer">
  3227. <nav class="md-footer__inner md-grid" aria-label="Footer">
  3228. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Oracle Vault" rel="prev">
  3229. <div class="md-footer__button md-icon">
  3230. <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 11h12z"/></svg>
  3231. </div>
  3232. <div class="md-footer__title">
  3233. <div class="md-ellipsis">
  3234. <span class="md-footer__direction">
  3235. Previous
  3236. </span>
  3237. Oracle Vault
  3238. </div>
  3239. </div>
  3240. </a>
  3241. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  3242. <div class="md-footer__title">
  3243. <div class="md-ellipsis">
  3244. <span class="md-footer__direction">
  3245. Next
  3246. </span>
  3247. Developer guide
  3248. </div>
  3249. </div>
  3250. <div class="md-footer__button md-icon">
  3251. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  3252. </div>
  3253. </a>
  3254. </nav>
  3255. <div class="md-footer-meta md-typeset">
  3256. <div class="md-footer-meta__inner md-grid">
  3257. <div class="md-footer-copyright">
  3258. Made with
  3259. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  3260. Material for MkDocs
  3261. </a>
  3262. </div>
  3263. </div>
  3264. </div>
  3265. </footer>
  3266. </div>
  3267. <div class="md-dialog" data-md-component="dialog">
  3268. <div class="md-dialog__inner md-typeset"></div>
  3269. </div>
  3270. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.b0710199.min.js", "version": null}</script>
  3271. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  3272. </body>
  3273. </html>