index.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425
  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.9">
  8. <title>Anchore Engine - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.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="#getting-started" 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. Anchore Engine
  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="../api-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. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-multi-tenancy/" class="md-nav__link">
  212. Multi Tenancy
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-metrics/" class="md-nav__link">
  217. Metrics
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-using-latest-image/" class="md-nav__link">
  222. Using Latest Image
  223. </a>
  224. </li>
  225. </ul>
  226. </nav>
  227. </li>
  228. <li class="md-nav__item md-nav__item--nested">
  229. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  230. <label class="md-nav__link" for="__nav_5">
  231. Provider
  232. <span class="md-nav__icon md-icon"></span>
  233. </label>
  234. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  235. <label class="md-nav__title" for="__nav_5">
  236. <span class="md-nav__icon md-icon"></span>
  237. Provider
  238. </label>
  239. <ul class="md-nav__list" data-md-scrollfix>
  240. <li class="md-nav__item md-nav__item--nested">
  241. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  242. <label class="md-nav__link" for="__nav_5_1">
  243. AWS
  244. <span class="md-nav__icon md-icon"></span>
  245. </label>
  246. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  247. <label class="md-nav__title" for="__nav_5_1">
  248. <span class="md-nav__icon md-icon"></span>
  249. AWS
  250. </label>
  251. <ul class="md-nav__list" data-md-scrollfix>
  252. <li class="md-nav__item">
  253. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  254. Secrets Manager
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  259. Parameter Store
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  267. <label class="md-nav__link" for="__nav_5_2">
  268. Azure
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_5_2">
  273. <span class="md-nav__icon md-icon"></span>
  274. Azure
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../provider-azure-key-vault/" class="md-nav__link">
  279. Key Vault
  280. </a>
  281. </li>
  282. </ul>
  283. </nav>
  284. </li>
  285. <li class="md-nav__item md-nav__item--nested">
  286. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  287. <label class="md-nav__link" for="__nav_5_3">
  288. Google
  289. <span class="md-nav__icon md-icon"></span>
  290. </label>
  291. <nav class="md-nav" aria-label="Google" data-md-level="2">
  292. <label class="md-nav__title" for="__nav_5_3">
  293. <span class="md-nav__icon md-icon"></span>
  294. Google
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  299. Secret Manager
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  307. <label class="md-nav__link" for="__nav_5_4">
  308. IBM
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. IBM
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  319. Secrets Manager
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../provider-akeyless/" class="md-nav__link">
  327. Akeyless
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  332. HashiCorp Vault
  333. </a>
  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_7" type="checkbox" id="__nav_5_7" >
  337. <label class="md-nav__link" for="__nav_5_7">
  338. Yandex
  339. <span class="md-nav__icon md-icon"></span>
  340. </label>
  341. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  342. <label class="md-nav__title" for="__nav_5_7">
  343. <span class="md-nav__icon md-icon"></span>
  344. Yandex
  345. </label>
  346. <ul class="md-nav__list" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  349. Lockbox
  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_8" type="checkbox" id="__nav_5_8" >
  357. <label class="md-nav__link" for="__nav_5_8">
  358. Gitlab
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_5_8">
  363. <span class="md-nav__icon md-icon"></span>
  364. Gitlab
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  369. Gitlab Project Variables
  370. </a>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  377. <label class="md-nav__link" for="__nav_5_9">
  378. Oracle
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_9">
  383. <span class="md-nav__icon md-icon"></span>
  384. Oracle
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-oracle-vault/" class="md-nav__link">
  389. Oracle Vault
  390. </a>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../provider-webhook/" class="md-nav__link">
  397. Webhook
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../provider-fake/" class="md-nav__link">
  402. Fake
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  409. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  410. <label class="md-nav__link" for="__nav_6">
  411. Examples
  412. <span class="md-nav__icon md-icon"></span>
  413. </label>
  414. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  415. <label class="md-nav__title" for="__nav_6">
  416. <span class="md-nav__icon md-icon"></span>
  417. Examples
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  422. FluxCD
  423. </a>
  424. </li>
  425. <li class="md-nav__item md-nav__item--active">
  426. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  427. <label class="md-nav__link md-nav__link--active" for="__toc">
  428. Anchore Engine
  429. <span class="md-nav__icon md-icon"></span>
  430. </label>
  431. <a href="./" class="md-nav__link md-nav__link--active">
  432. Anchore Engine
  433. </a>
  434. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  435. <label class="md-nav__title" for="__toc">
  436. <span class="md-nav__icon md-icon"></span>
  437. Table of contents
  438. </label>
  439. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="#installing-with-helm" class="md-nav__link">
  442. Installing with Helm
  443. </a>
  444. <nav class="md-nav" aria-label="Installing with Helm">
  445. <ul class="md-nav__list">
  446. <li class="md-nav__item">
  447. <a href="#hashicorp-vault" class="md-nav__link">
  448. Hashicorp Vault
  449. </a>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="#aws-secrets-manager" class="md-nav__link">
  453. AWS Secrets Manager
  454. </a>
  455. </li>
  456. </ul>
  457. </nav>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  464. Jenkins
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. <li class="md-nav__item md-nav__item--nested">
  471. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  472. <label class="md-nav__link" for="__nav_7">
  473. References
  474. <span class="md-nav__icon md-icon"></span>
  475. </label>
  476. <nav class="md-nav" aria-label="References" data-md-level="1">
  477. <label class="md-nav__title" for="__nav_7">
  478. <span class="md-nav__icon md-icon"></span>
  479. References
  480. </label>
  481. <ul class="md-nav__list" data-md-scrollfix>
  482. <li class="md-nav__item">
  483. <a href="../spec/" class="md-nav__link">
  484. API specification
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </li>
  490. <li class="md-nav__item md-nav__item--nested">
  491. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  492. <label class="md-nav__link" for="__nav_8">
  493. Contributing
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  497. <label class="md-nav__title" for="__nav_8">
  498. <span class="md-nav__icon md-icon"></span>
  499. Contributing
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../contributing-devguide/" class="md-nav__link">
  504. Developer guide
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../contributing-process/" class="md-nav__link">
  509. Contributing Process
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../contributing-coc/" class="md-nav__link">
  514. Code of Conduct
  515. </a>
  516. </li>
  517. </ul>
  518. </nav>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../deprecation-policy/" class="md-nav__link">
  522. Deprecation Policy
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </div>
  528. </div>
  529. </div>
  530. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  531. <div class="md-sidebar__scrollwrap">
  532. <div class="md-sidebar__inner">
  533. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  534. <label class="md-nav__title" for="__toc">
  535. <span class="md-nav__icon md-icon"></span>
  536. Table of contents
  537. </label>
  538. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  539. <li class="md-nav__item">
  540. <a href="#installing-with-helm" class="md-nav__link">
  541. Installing with Helm
  542. </a>
  543. <nav class="md-nav" aria-label="Installing with Helm">
  544. <ul class="md-nav__list">
  545. <li class="md-nav__item">
  546. <a href="#hashicorp-vault" class="md-nav__link">
  547. Hashicorp Vault
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#aws-secrets-manager" class="md-nav__link">
  552. AWS Secrets Manager
  553. </a>
  554. </li>
  555. </ul>
  556. </nav>
  557. </li>
  558. </ul>
  559. </nav>
  560. </div>
  561. </div>
  562. </div>
  563. <div class="md-content" data-md-component="content">
  564. <article class="md-content__inner md-typeset">
  565. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/examples-anchore-engine-credentials.md" title="Edit this page" class="md-content__button md-icon">
  566. <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>
  567. </a>
  568. <h1 id="getting-started">Getting started</h1>
  569. <p>Anchore Engine is an open-source project that provides a centralized service for inspection, analysis, and certification of container images. With Kubernetes, it also brings nice features like preventing unscanned images from being deployed into your clusters</p>
  570. <h2 id="installing-with-helm">Installing with Helm</h2>
  571. <p>There are several parts of the installation that require credentials these being :-</p>
  572. <p>ANCHORE_ADMIN_USERNAME
  573. ANCHORE_ADMIN_PASSWORD
  574. ANCHORE_DB_PASSWORD
  575. db-url
  576. db-user
  577. postgres-password</p>
  578. <p>Creating the following external secret ensure the credentials are drawn from the backend provider of choice. The example shown here works with Hashicorp Vault and AWS Secrets Manager providers.</p>
  579. <h4 id="hashicorp-vault">Hashicorp Vault</h4>
  580. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  581. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  582. <span class="nt">metadata</span><span class="p">:</span>
  583. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-access-credentials</span>
  584. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">security</span>
  585. <span class="nt">spec</span><span class="p">:</span>
  586. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1m</span>
  587. <span class="nt">secretStoreRef</span><span class="p">:</span>
  588. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  589. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  590. <span class="nt">target</span><span class="p">:</span>
  591. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-access-credentials</span>
  592. <span class="nt">template</span><span class="p">:</span>
  593. <span class="nt">data</span><span class="p">:</span>
  594. <span class="nt">ANCHORE_ADMIN_USERNAME</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  595. <span class="no">{{ printf &quot;{{ .username | toString }}&quot; }}</span>
  596. <span class="nt">ANCHORE_ADMIN_PASSWORD</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  597. <span class="no">{{ printf &quot;{{ .password | toString }}&quot; }}</span>
  598. <span class="nt">ANCHORE_DB_PASSWORD</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  599. <span class="no">{{ printf &quot;{{ .dbPassword | toString }}&quot; }}</span>
  600. <span class="nt">db-url</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  601. <span class="no">{{ printf &quot;{{ .dbUrl | toString }}&quot; }}</span>
  602. <span class="nt">db-user</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  603. <span class="no">{{ printf &quot;{{ .dbUser | toString }}&quot; }}</span>
  604. <span class="nt">postgres-password</span><span class="p">:</span> <span class="p p-Indicator">&gt;-</span>
  605. <span class="no">{{ printf &quot;{{ .postgresPassword | toString }}&quot; }}</span>
  606. <span class="nt">data</span><span class="p">:</span>
  607. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">password</span>
  608. <span class="nt">remoteRef</span><span class="p">:</span>
  609. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  610. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ANCHORE_ADMIN_PASSWORD</span>
  611. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">username</span>
  612. <span class="nt">remoteRef</span><span class="p">:</span>
  613. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  614. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ANCHORE_ADMIN_USERNAME</span>
  615. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dbPassword</span>
  616. <span class="nt">remoteRef</span><span class="p">:</span>
  617. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  618. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ANCHORE_DB_PASSWORD</span>
  619. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dbUrl</span>
  620. <span class="nt">remoteRef</span><span class="p">:</span>
  621. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  622. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">db-url</span>
  623. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dbUser</span>
  624. <span class="nt">remoteRef</span><span class="p">:</span>
  625. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  626. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">db-user</span>
  627. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">postgresPassword</span>
  628. <span class="nt">remoteRef</span><span class="p">:</span>
  629. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-engine</span>
  630. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">postgres-password</span>
  631. </code></pre></div>
  632. <h4 id="aws-secrets-manager">AWS Secrets Manager</h4>
  633. <div class="highlight"><pre><span></span><code><span class="nn">---</span>
  634. <span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  635. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  636. <span class="nt">metadata</span><span class="p">:</span>
  637. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-access-credentials</span>
  638. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ci</span>
  639. <span class="nt">spec</span><span class="p">:</span>
  640. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1m</span>
  641. <span class="nt">secretStoreRef</span><span class="p">:</span>
  642. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">cluster-secrets-store</span>
  643. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  644. <span class="nt">target</span><span class="p">:</span>
  645. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">anchore-access-credentials</span>
  646. <span class="nt">dataFrom</span><span class="p">:</span>
  647. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">service/anchore-engine/engineAccess</span>
  648. </code></pre></div>
  649. </article>
  650. </div>
  651. </div>
  652. </main>
  653. <footer class="md-footer">
  654. <nav class="md-footer__inner md-grid" aria-label="Footer">
  655. <a href="../examples-gitops-using-fluxcd/" class="md-footer__link md-footer__link--prev" aria-label="Previous: FluxCD" rel="prev">
  656. <div class="md-footer__button md-icon">
  657. <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>
  658. </div>
  659. <div class="md-footer__title">
  660. <div class="md-ellipsis">
  661. <span class="md-footer__direction">
  662. Previous
  663. </span>
  664. FluxCD
  665. </div>
  666. </div>
  667. </a>
  668. <a href="../examples-jenkins-kubernetes-credentials/" class="md-footer__link md-footer__link--next" aria-label="Next: Jenkins" rel="next">
  669. <div class="md-footer__title">
  670. <div class="md-ellipsis">
  671. <span class="md-footer__direction">
  672. Next
  673. </span>
  674. Jenkins
  675. </div>
  676. </div>
  677. <div class="md-footer__button md-icon">
  678. <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>
  679. </div>
  680. </a>
  681. </nav>
  682. <div class="md-footer-meta md-typeset">
  683. <div class="md-footer-meta__inner md-grid">
  684. <div class="md-copyright">
  685. Made with
  686. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  687. Material for MkDocs
  688. </a>
  689. </div>
  690. </div>
  691. </div>
  692. </footer>
  693. </div>
  694. <div class="md-dialog" data-md-component="dialog">
  695. <div class="md-dialog__inner md-typeset"></div>
  696. </div>
  697. <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.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  698. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  699. </body>
  700. </html>