index.html 78 KB

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