index.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983
  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.2.3, mkdocs-material-8.1.10">
  8. <title>Akeyless - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.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:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  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. <a href="#akeyless-vault" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Akeyless
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href="../.." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../../overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../../api/externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../../api/secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../../api/clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../../guides/introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../guides/getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../../guides/templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../guides/templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../guides/controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  242. Decoding Strategies
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../guides/getallsecrets/" class="md-nav__link">
  247. Getting Multiple Secrets
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  252. Multi Tenancy
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../guides/metrics/" class="md-nav__link">
  257. Metrics
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  262. Rewriting Keys
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="../../guides/v1beta1/" class="md-nav__link">
  267. Upgrading to v1beta1
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../../guides/using-latest-image/" class="md-nav__link">
  272. Using Latest Image
  273. </a>
  274. </li>
  275. </ul>
  276. </nav>
  277. </li>
  278. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  279. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  280. <label class="md-nav__link" for="__nav_5">
  281. Provider
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  285. <label class="md-nav__title" for="__nav_5">
  286. <span class="md-nav__icon md-icon"></span>
  287. Provider
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  292. <label class="md-nav__link" for="__nav_5_1">
  293. AWS
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_1">
  298. <span class="md-nav__icon md-icon"></span>
  299. AWS
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../aws-secrets-manager/" class="md-nav__link">
  304. Secrets Manager
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../aws-parameter-store/" class="md-nav__link">
  309. Parameter Store
  310. </a>
  311. </li>
  312. </ul>
  313. </nav>
  314. </li>
  315. <li class="md-nav__item md-nav__item--nested">
  316. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  317. <label class="md-nav__link" for="__nav_5_2">
  318. Azure
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  322. <label class="md-nav__title" for="__nav_5_2">
  323. <span class="md-nav__icon md-icon"></span>
  324. Azure
  325. </label>
  326. <ul class="md-nav__list" data-md-scrollfix>
  327. <li class="md-nav__item">
  328. <a href="../azure-key-vault/" class="md-nav__link">
  329. Key Vault
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. <li class="md-nav__item md-nav__item--nested">
  336. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  337. <label class="md-nav__link" for="__nav_5_3">
  338. Google
  339. <span class="md-nav__icon md-icon"></span>
  340. </label>
  341. <nav class="md-nav" aria-label="Google" data-md-level="2">
  342. <label class="md-nav__title" for="__nav_5_3">
  343. <span class="md-nav__icon md-icon"></span>
  344. Google
  345. </label>
  346. <ul class="md-nav__list" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="../google-secrets-manager/" class="md-nav__link">
  349. Secret Manager
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  357. <label class="md-nav__link" for="__nav_5_4">
  358. IBM
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_5_4">
  363. <span class="md-nav__icon md-icon"></span>
  364. IBM
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../ibm-secrets-manager/" class="md-nav__link">
  369. Secrets Manager
  370. </a>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item md-nav__item--active">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  377. <label class="md-nav__link md-nav__link--active" for="__toc">
  378. Akeyless
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <a href="./" class="md-nav__link md-nav__link--active">
  382. Akeyless
  383. </a>
  384. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  385. <label class="md-nav__title" for="__toc">
  386. <span class="md-nav__icon md-icon"></span>
  387. Table of contents
  388. </label>
  389. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="#akeyless-vault" class="md-nav__link">
  392. Akeyless Vault
  393. </a>
  394. <nav class="md-nav" aria-label="Akeyless Vault">
  395. <ul class="md-nav__list">
  396. <li class="md-nav__item">
  397. <a href="#authentication" class="md-nav__link">
  398. Authentication
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="#creating-an-akeyless-ccredentials-secret" class="md-nav__link">
  403. Creating an Akeyless Ccredentials Secret
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="#update-secret-store" class="md-nav__link">
  408. Update Secret Store
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="#authentication-with-kubernetes" class="md-nav__link">
  413. Authentication with Kubernetes
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="#creating-an-external-secret" class="md-nav__link">
  418. Creating an external secret
  419. </a>
  420. <nav class="md-nav" aria-label="Creating an external secret">
  421. <ul class="md-nav__list">
  422. <li class="md-nav__item">
  423. <a href="#using-datafrom" class="md-nav__link">
  424. Using DataFrom
  425. </a>
  426. </li>
  427. </ul>
  428. </nav>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  432. Getting the Kubernetes Secret
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. </ul>
  439. </nav>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../hashicorp-vault/" class="md-nav__link">
  443. HashiCorp Vault
  444. </a>
  445. </li>
  446. <li class="md-nav__item md-nav__item--nested">
  447. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  448. <label class="md-nav__link" for="__nav_5_7">
  449. Yandex
  450. <span class="md-nav__icon md-icon"></span>
  451. </label>
  452. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  453. <label class="md-nav__title" for="__nav_5_7">
  454. <span class="md-nav__icon md-icon"></span>
  455. Yandex
  456. </label>
  457. <ul class="md-nav__list" data-md-scrollfix>
  458. <li class="md-nav__item">
  459. <a href="../yandex-certificate-manager/" class="md-nav__link">
  460. Certificate Manager
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../yandex-lockbox/" class="md-nav__link">
  465. Lockbox
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  473. <label class="md-nav__link" for="__nav_5_8">
  474. Gitlab
  475. <span class="md-nav__icon md-icon"></span>
  476. </label>
  477. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  478. <label class="md-nav__title" for="__nav_5_8">
  479. <span class="md-nav__icon md-icon"></span>
  480. Gitlab
  481. </label>
  482. <ul class="md-nav__list" data-md-scrollfix>
  483. <li class="md-nav__item">
  484. <a href="../gitlab-project-variables/" class="md-nav__link">
  485. Gitlab Project Variables
  486. </a>
  487. </li>
  488. </ul>
  489. </nav>
  490. </li>
  491. <li class="md-nav__item md-nav__item--nested">
  492. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  493. <label class="md-nav__link" for="__nav_5_9">
  494. Oracle
  495. <span class="md-nav__icon md-icon"></span>
  496. </label>
  497. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  498. <label class="md-nav__title" for="__nav_5_9">
  499. <span class="md-nav__icon md-icon"></span>
  500. Oracle
  501. </label>
  502. <ul class="md-nav__list" data-md-scrollfix>
  503. <li class="md-nav__item">
  504. <a href="../oracle-vault/" class="md-nav__link">
  505. Oracle Vault
  506. </a>
  507. </li>
  508. </ul>
  509. </nav>
  510. </li>
  511. <li class="md-nav__item md-nav__item--nested">
  512. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  513. <label class="md-nav__link" for="__nav_5_10">
  514. 1Password
  515. <span class="md-nav__icon md-icon"></span>
  516. </label>
  517. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  518. <label class="md-nav__title" for="__nav_5_10">
  519. <span class="md-nav__icon md-icon"></span>
  520. 1Password
  521. </label>
  522. <ul class="md-nav__list" data-md-scrollfix>
  523. <li class="md-nav__item">
  524. <a href="../1password-automation/" class="md-nav__link">
  525. Secrets Automation
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../webhook/" class="md-nav__link">
  533. Webhook
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../fake/" class="md-nav__link">
  538. Fake
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../kubernetes/" class="md-nav__link">
  543. Kubernetes
  544. </a>
  545. </li>
  546. <li class="md-nav__item md-nav__item--nested">
  547. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  548. <label class="md-nav__link" for="__nav_5_14">
  549. senhasegura
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  553. <label class="md-nav__title" for="__nav_5_14">
  554. <span class="md-nav__icon md-icon"></span>
  555. senhasegura
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="../senhasegura-dsm/" class="md-nav__link">
  560. DevOps Secrets Management (DSM)
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../doppler/" class="md-nav__link">
  568. Doppler
  569. </a>
  570. </li>
  571. </ul>
  572. </nav>
  573. </li>
  574. <li class="md-nav__item md-nav__item--nested">
  575. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  576. <label class="md-nav__link" for="__nav_6">
  577. Examples
  578. <span class="md-nav__icon md-icon"></span>
  579. </label>
  580. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  581. <label class="md-nav__title" for="__nav_6">
  582. <span class="md-nav__icon md-icon"></span>
  583. Examples
  584. </label>
  585. <ul class="md-nav__list" data-md-scrollfix>
  586. <li class="md-nav__item">
  587. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  588. FluxCD
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  593. Anchore Engine
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  598. Jenkins
  599. </a>
  600. </li>
  601. </ul>
  602. </nav>
  603. </li>
  604. <li class="md-nav__item md-nav__item--nested">
  605. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  606. <label class="md-nav__link" for="__nav_7">
  607. External Resources
  608. <span class="md-nav__icon md-icon"></span>
  609. </label>
  610. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  611. <label class="md-nav__title" for="__nav_7">
  612. <span class="md-nav__icon md-icon"></span>
  613. External Resources
  614. </label>
  615. <ul class="md-nav__list" data-md-scrollfix>
  616. <li class="md-nav__item">
  617. <a href="../../eso-talks/" class="md-nav__link">
  618. Talks
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../eso-demos/" class="md-nav__link">
  623. Demos
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../eso-blogs/" class="md-nav__link">
  628. Blogs
  629. </a>
  630. </li>
  631. </ul>
  632. </nav>
  633. </li>
  634. <li class="md-nav__item md-nav__item--nested">
  635. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  636. <label class="md-nav__link" for="__nav_8">
  637. References
  638. <span class="md-nav__icon md-icon"></span>
  639. </label>
  640. <nav class="md-nav" aria-label="References" data-md-level="1">
  641. <label class="md-nav__title" for="__nav_8">
  642. <span class="md-nav__icon md-icon"></span>
  643. References
  644. </label>
  645. <ul class="md-nav__list" data-md-scrollfix>
  646. <li class="md-nav__item">
  647. <a href="../../spec/" class="md-nav__link">
  648. API specification
  649. </a>
  650. </li>
  651. </ul>
  652. </nav>
  653. </li>
  654. <li class="md-nav__item md-nav__item--nested">
  655. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  656. <label class="md-nav__link" for="__nav_9">
  657. Contributing
  658. <span class="md-nav__icon md-icon"></span>
  659. </label>
  660. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  661. <label class="md-nav__title" for="__nav_9">
  662. <span class="md-nav__icon md-icon"></span>
  663. Contributing
  664. </label>
  665. <ul class="md-nav__list" data-md-scrollfix>
  666. <li class="md-nav__item">
  667. <a href="../../contributing/devguide/" class="md-nav__link">
  668. Developer guide
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../contributing/process/" class="md-nav__link">
  673. Contributing Process
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../contributing/release/" class="md-nav__link">
  678. Release Process
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../../contributing/coc/" class="md-nav__link">
  683. Code of Conduct
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../../contributing/roadmap/" class="md-nav__link">
  688. Roadmap
  689. </a>
  690. </li>
  691. </ul>
  692. </nav>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../../faq/" class="md-nav__link">
  696. FAQ
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../stability-support/" class="md-nav__link">
  701. Stability and Support
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../deprecation-policy/" class="md-nav__link">
  706. Deprecation Policy
  707. </a>
  708. </li>
  709. </ul>
  710. </nav>
  711. </div>
  712. </div>
  713. </div>
  714. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  715. <div class="md-sidebar__scrollwrap">
  716. <div class="md-sidebar__inner">
  717. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  718. <label class="md-nav__title" for="__toc">
  719. <span class="md-nav__icon md-icon"></span>
  720. Table of contents
  721. </label>
  722. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  723. <li class="md-nav__item">
  724. <a href="#akeyless-vault" class="md-nav__link">
  725. Akeyless Vault
  726. </a>
  727. <nav class="md-nav" aria-label="Akeyless Vault">
  728. <ul class="md-nav__list">
  729. <li class="md-nav__item">
  730. <a href="#authentication" class="md-nav__link">
  731. Authentication
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="#creating-an-akeyless-ccredentials-secret" class="md-nav__link">
  736. Creating an Akeyless Ccredentials Secret
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#update-secret-store" class="md-nav__link">
  741. Update Secret Store
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#authentication-with-kubernetes" class="md-nav__link">
  746. Authentication with Kubernetes
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="#creating-an-external-secret" class="md-nav__link">
  751. Creating an external secret
  752. </a>
  753. <nav class="md-nav" aria-label="Creating an external secret">
  754. <ul class="md-nav__list">
  755. <li class="md-nav__item">
  756. <a href="#using-datafrom" class="md-nav__link">
  757. Using DataFrom
  758. </a>
  759. </li>
  760. </ul>
  761. </nav>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  765. Getting the Kubernetes Secret
  766. </a>
  767. </li>
  768. </ul>
  769. </nav>
  770. </li>
  771. </ul>
  772. </nav>
  773. </div>
  774. </div>
  775. </div>
  776. <div class="md-content" data-md-component="content">
  777. <article class="md-content__inner md-typeset">
  778. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/akeyless.md" title="Edit this page" class="md-content__button md-icon">
  779. <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>
  780. </a>
  781. <h1>Akeyless</h1>
  782. <h2 id="akeyless-vault">Akeyless Vault</h2>
  783. <p>External Secrets Operator integrates with the <a href="https://docs.akeyless.io/reference#v2">Akeyless API</a>.</p>
  784. <h3 id="authentication">Authentication</h3>
  785. <p>To operate the API first define an access-id, access-type and access-Type-param.</p>
  786. <p>The supported auth-methods and their parameters are:</p>
  787. <table>
  788. <thead>
  789. <tr>
  790. <th>accessType</th>
  791. <th>accessTypeParam</th>
  792. </tr>
  793. </thead>
  794. <tbody>
  795. <tr>
  796. <td><code>api_key</code></td>
  797. <td>The access key.</td>
  798. </tr>
  799. <tr>
  800. <td><code>k8s</code></td>
  801. <td>The k8s configuration name</td>
  802. </tr>
  803. <tr>
  804. <td><code>aws_iam</code></td>
  805. <td>-</td>
  806. </tr>
  807. <tr>
  808. <td><code>gcp</code></td>
  809. <td>The gcp audience</td>
  810. </tr>
  811. <tr>
  812. <td><code>azure_ad</code></td>
  813. <td>azure object id (optional)</td>
  814. </tr>
  815. </tbody>
  816. </table>
  817. <p>For more information see <a href="https://docs.akeyless.io/docs/access-and-authentication-methods">Akeyless Authentication Methods</a></p>
  818. <h3 id="creating-an-akeyless-ccredentials-secret">Creating an Akeyless Ccredentials Secret</h3>
  819. <p>Create a secret containing your credentials using the following example as a guide:</p>
  820. <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><span class="w"></span>
  821. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  822. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  823. <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">akeyless-secret-creds</span><span class="w"></span>
  824. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"></span>
  825. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">accessId</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;p-XXXX&quot;</span><span class="w"></span>
  827. <span class="w"> </span><span class="nt">accessType</span><span class="p">:</span><span class="w"> </span><span class="c1"># k8s/aws_iam/gcp/azure_ad/api_key</span><span class="w"></span>
  828. <span class="w"> </span><span class="nt">accessTypeParam</span><span class="p">:</span><span class="w"> </span><span class="c1"># can be one of the following: k8s-conf-name/gcp-audience/azure-obj-id/access-key</span><span class="w"></span>
  829. </code></pre></div>
  830. <h3 id="update-secret-store">Update Secret Store</h3>
  831. <p>Be sure the <code>akeyless</code> provider is listed in the <code>Kind=SecretStore</code> and the <code>akeylessGWApiURL</code> is set (def: "https://api.akeless.io").</p>
  832. <p><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><span class="w"></span>
  833. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  834. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  835. <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">akeyless-secret-store</span><span class="w"></span>
  836. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">akeyless</span><span class="p">:</span><span class="w"></span>
  839. <span class="w"> </span><span class="c1"># URL of your akeyless API</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">akeylessGWApiURL</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://api.akeyless.io&quot;</span><span class="w"></span>
  841. <span class="w"> </span><span class="nt">authSecretRef</span><span class="p">:</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">accessID</span><span class="p">:</span><span class="w"></span>
  844. <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">akeyless-secret-creds</span><span class="w"></span>
  845. <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">accessId</span><span class="w"></span>
  846. <span class="w"> </span><span class="nt">accessType</span><span class="p">:</span><span class="w"></span>
  847. <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">akeyless-secret-creds</span><span class="w"></span>
  848. <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">accessType</span><span class="w"></span>
  849. <span class="w"> </span><span class="nt">accessTypeParam</span><span class="p">:</span><span class="w"></span>
  850. <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">akeyless-secret-creds</span><span class="w"></span>
  851. <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">accessTypeParam</span><span class="w"></span>
  852. </code></pre></div>
  853. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, be sure to provide <code>namespace</code> for <code>accessID</code>, <code>accessType</code> and <code>accessTypeParam</code> according to the namespaces where the secrets reside.</p>
  854. <h3 id="authentication-with-kubernetes">Authentication with Kubernetes</h3>
  855. <p>Options for obtaining Kubernetes credentials include:</p>
  856. <ol>
  857. <li>Using a service account jwt referenced in serviceAccountRef</li>
  858. <li>Using the jwt from a Kind=Secret referenced by the secretRef</li>
  859. <li>Using transient credentials from the mounted service account token within the external-secrets operator</li>
  860. </ol>
  861. <p><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><span class="w"></span>
  862. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  863. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  864. <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">akeyless-secret-store</span><span class="w"></span>
  865. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  866. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  867. <span class="w"> </span><span class="nt">akeyless</span><span class="p">:</span><span class="w"></span>
  868. <span class="w"> </span><span class="c1"># URL of your akeyless API</span><span class="w"></span>
  869. <span class="w"> </span><span class="nt">akeylessGWApiURL</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://api.akeyless.io&quot;</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">authSecretRef</span><span class="p">:</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">kubernetesAuth</span><span class="p">:</span><span class="w"></span>
  872. <span class="w"> </span><span class="nt">accessID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;p-XXXXXX&quot;</span><span class="w"></span>
  873. <span class="w"> </span><span class="nt">k8sConfName</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-conf-name&quot;</span><span class="w"></span>
  874. <span class="w"> </span><span class="c1"># Optional service account field containing the name</span><span class="w"></span>
  875. <span class="w"> </span><span class="c1"># of a kubernetes ServiceAccount</span><span class="w"></span>
  876. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span><span class="w"></span>
  878. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span><span class="w"></span>
  879. <span class="w"> </span><span class="c1"># used for authenticating with Akeyless</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  881. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span><span class="w"></span>
  882. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span><span class="w"></span>
  883. </code></pre></div>
  884. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>serviceAccountRef</code> and <code>secretRef</code> according to the namespaces where the secrets reside.</p>
  885. <h3 id="creating-an-external-secret">Creating an external secret</h3>
  886. <p>To get a secret from Akeyless and create it as a secret on the Kubernetes cluster, a <code>Kind=ExternalSecret</code> is needed.</p>
  887. <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><span class="w"></span>
  888. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  889. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  890. <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">akeyless-external-secret-example</span><span class="w"></span>
  891. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  892. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  894. <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><span class="w"></span>
  895. <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">akeyless-secret-store</span><span class="w"> </span><span class="c1"># Must match SecretStore on the cluster</span><span class="w"></span>
  896. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  897. <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">akeyless-secret-to-create</span><span class="w"> </span><span class="c1"># Name for the secret to be created on the cluster</span><span class="w"></span>
  898. <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><span class="w"></span>
  899. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  900. <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">secretKey</span><span class="w"> </span><span class="c1"># Key given to the secret to be created on the cluster</span><span class="w"></span>
  901. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  902. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-name</span><span class="w"> </span><span class="c1"># Full path of the secret on Akeyless</span><span class="w"></span>
  903. </code></pre></div>
  904. <h4 id="using-datafrom">Using DataFrom</h4>
  905. <p>DataFrom can be used to get a secret as a JSON string and attempt to parse it.</p>
  906. <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><span class="w"></span>
  907. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  908. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  909. <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">akeyless-external-secret-example-json</span><span class="w"></span>
  910. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  911. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  912. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  913. <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><span class="w"></span>
  914. <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">akeyless-secret-store</span><span class="w"> </span><span class="c1"># Must match SecretStore on the cluster</span><span class="w"></span>
  915. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  916. <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">akeyless-secret-to-create-json</span><span class="w"> </span><span class="c1"># Name for the secret to be created on the cluster</span><span class="w"></span>
  917. <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><span class="w"></span>
  918. <span class="w"> </span><span class="c1"># for json formatted secrets: each key in the json will be used as the secret key in the SECRET k8s target object</span><span class="w"></span>
  919. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  920. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  921. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-name</span><span class="w"> </span><span class="c1"># Full path of the secret on Akeyless</span><span class="w"></span>
  922. </code></pre></div>
  923. <h3 id="getting-the-kubernetes-secret">Getting the Kubernetes Secret</h3>
  924. <p>The operator will fetch the secret and inject it as a <code>Kind=Secret</code>.
  925. <div class="highlight"><pre><span></span><code>kubectl get secret akeyless-secret-to-create -o jsonpath=&#39;{.data.secretKey}&#39; | base64 -d
  926. </code></pre></div></p>
  927. <div class="highlight"><pre><span></span><code>kubectl get secret akeyless-secret-to-create-json -o jsonpath=&#39;{.data}&#39;
  928. </code></pre></div>
  929. </article>
  930. </div>
  931. </div>
  932. </main>
  933. <footer class="md-footer">
  934. <nav class="md-footer__inner md-grid" aria-label="Footer">
  935. <a href="../ibm-secrets-manager/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Secrets Manager" rel="prev">
  936. <div class="md-footer__button md-icon">
  937. <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>
  938. </div>
  939. <div class="md-footer__title">
  940. <div class="md-ellipsis">
  941. <span class="md-footer__direction">
  942. Previous
  943. </span>
  944. Secrets Manager
  945. </div>
  946. </div>
  947. </a>
  948. <a href="../hashicorp-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: HashiCorp Vault" rel="next">
  949. <div class="md-footer__title">
  950. <div class="md-ellipsis">
  951. <span class="md-footer__direction">
  952. Next
  953. </span>
  954. HashiCorp Vault
  955. </div>
  956. </div>
  957. <div class="md-footer__button md-icon">
  958. <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>
  959. </div>
  960. </a>
  961. </nav>
  962. <div class="md-footer-meta md-typeset">
  963. <div class="md-footer-meta__inner md-grid">
  964. <div class="md-copyright">
  965. <div class="md-copyright__highlight">
  966. &copy; 2022 The external-secrets Authors.<br/>
  967. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  968. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  969. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  970. </div>
  971. Made with
  972. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  973. Material for MkDocs
  974. </a>
  975. </div>
  976. </div>
  977. </div>
  978. </footer>
  979. </div>
  980. <div class="md-dialog" data-md-component="dialog">
  981. <div class="md-dialog__inner md-typeset"></div>
  982. </div>
  983. <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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  984. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  985. </body>
  986. </html>