index.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  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. <meta http-equiv="x-ua-compatible" content="ie=edge">
  7. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  8. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  9. <meta name="lang:search.language" content="en">
  10. <meta name="lang:search.pipeline.stopwords" content="True">
  11. <meta name="lang:search.pipeline.trimmer" content="True">
  12. <meta name="lang:search.result.none" content="No matching documents">
  13. <meta name="lang:search.result.one" content="1 matching document">
  14. <meta name="lang:search.result.other" content="# matching documents">
  15. <meta name="lang:search.tokenizer" content="[\s\-]+">
  16. <link rel="shortcut icon" href="assets/images/favicon.png">
  17. <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
  18. <title>External Secrets Operator</title>
  19. <link rel="stylesheet" href="assets/stylesheets/application.1b62728e.css">
  20. <script src="assets/javascripts/modernizr.268332fc.js"></script>
  21. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  22. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  23. <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  24. <link rel="stylesheet" href="assets/fonts/material-icons.css">
  25. </head>
  26. <body dir="ltr">
  27. <svg class="md-svg">
  28. <defs>
  29. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  30. </defs>
  31. </svg>
  32. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  33. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  34. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  35. <a href="#introduction" tabindex="1" class="md-skip">
  36. Skip to content
  37. </a>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header-nav md-grid">
  40. <div class="md-flex">
  41. <div class="md-flex__cell md-flex__cell--shrink">
  42. <a href="." title="External Secrets Operator" class="md-header-nav__button md-logo">
  43. <i class="md-icon"></i>
  44. </a>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--shrink">
  47. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  48. </div>
  49. <div class="md-flex__cell md-flex__cell--stretch">
  50. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  51. <span class="md-header-nav__topic">
  52. External Secrets Operator
  53. </span>
  54. <span class="md-header-nav__topic">
  55. Introduction
  56. </span>
  57. </div>
  58. </div>
  59. <div class="md-flex__cell md-flex__cell--shrink">
  60. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  61. <div class="md-search" data-md-component="search" role="dialog">
  62. <label class="md-search__overlay" for="__search"></label>
  63. <div class="md-search__inner" role="search">
  64. <form class="md-search__form" name="search">
  65. <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
  66. <label class="md-icon md-search__icon" for="__search"></label>
  67. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  68. &#xE5CD;
  69. </button>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="result">
  74. <div class="md-search-result__meta">
  75. Type to start searching
  76. </div>
  77. <ol class="md-search-result__list"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </div>
  84. <div class="md-flex__cell md-flex__cell--shrink">
  85. <div class="md-header-nav__source">
  86. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  87. <div class="md-source__icon">
  88. <svg viewBox="0 0 24 24" width="24" height="24">
  89. <use xlink:href="#__github" width="24" height="24"></use>
  90. </svg>
  91. </div>
  92. <div class="md-source__repository">
  93. External Secrets Operator
  94. </div>
  95. </a>
  96. </div>
  97. </div>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container">
  102. <main class="md-main" role="main">
  103. <div class="md-main__inner md-grid" data-md-component="container">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" data-md-level="0">
  108. <label class="md-nav__title md-nav__title--site" for="__drawer">
  109. <a href="." title="External Secrets Operator" class="md-nav__button md-logo">
  110. <i class="md-icon"></i>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  116. <div class="md-source__icon">
  117. <svg viewBox="0 0 24 24" width="24" height="24">
  118. <use xlink:href="#__github" width="24" height="24"></use>
  119. </svg>
  120. </div>
  121. <div class="md-source__repository">
  122. External Secrets Operator
  123. </div>
  124. </a>
  125. </div>
  126. <ul class="md-nav__list" data-md-scrollfix>
  127. <li class="md-nav__item md-nav__item--active">
  128. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  129. <label class="md-nav__link md-nav__link--active" for="__toc">
  130. Introduction
  131. </label>
  132. <a href="." title="Introduction" class="md-nav__link md-nav__link--active">
  133. Introduction
  134. </a>
  135. <nav class="md-nav md-nav--secondary">
  136. <label class="md-nav__title" for="__toc">Table of contents</label>
  137. <ul class="md-nav__list" data-md-scrollfix>
  138. <li class="md-nav__item">
  139. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  140. What is the goal of External Secrets Operator?
  141. </a>
  142. </li>
  143. <li class="md-nav__item">
  144. <a href="#where-to-get-started" class="md-nav__link">
  145. Where to get started
  146. </a>
  147. </li>
  148. <li class="md-nav__item">
  149. <a href="#how-to-get-involved" class="md-nav__link">
  150. How to get involved
  151. </a>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="#kicked-off-by" class="md-nav__link">
  155. Kicked off by
  156. </a>
  157. </li>
  158. </ul>
  159. </nav>
  160. </li>
  161. <li class="md-nav__item">
  162. <a href="api-overview/" title="Overview" class="md-nav__link">
  163. Overview
  164. </a>
  165. </li>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
  168. <label class="md-nav__link" for="nav-3">
  169. API Types
  170. </label>
  171. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  172. <label class="md-nav__title" for="nav-3">
  173. API Types
  174. </label>
  175. <ul class="md-nav__list" data-md-scrollfix>
  176. <li class="md-nav__item">
  177. <a href="api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  178. ExternalSecret
  179. </a>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="api-secretstore/" title="SecretStore" class="md-nav__link">
  183. SecretStore
  184. </a>
  185. </li>
  186. <li class="md-nav__item">
  187. <a href="api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  188. ClusterSecretStore
  189. </a>
  190. </li>
  191. </ul>
  192. </nav>
  193. </li>
  194. <li class="md-nav__item md-nav__item--nested">
  195. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  196. <label class="md-nav__link" for="nav-4">
  197. Guides
  198. </label>
  199. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  200. <label class="md-nav__title" for="nav-4">
  201. Guides
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item">
  205. <a href="guides-introduction/" title="Introduction" class="md-nav__link">
  206. Introduction
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="guides-getting-started/" title="Getting started" class="md-nav__link">
  211. Getting started
  212. </a>
  213. </li>
  214. <li class="md-nav__item">
  215. <a href="guides-templating/" title="Advanced Templating" class="md-nav__link">
  216. Advanced Templating
  217. </a>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  221. Multi Tenancy
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="guides-metrics/" title="Metrics" class="md-nav__link">
  226. Metrics
  227. </a>
  228. </li>
  229. </ul>
  230. </nav>
  231. </li>
  232. <li class="md-nav__item md-nav__item--nested">
  233. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  234. <label class="md-nav__link" for="nav-5">
  235. Provider
  236. </label>
  237. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  238. <label class="md-nav__title" for="nav-5">
  239. Provider
  240. </label>
  241. <ul class="md-nav__list" data-md-scrollfix>
  242. <li class="md-nav__item md-nav__item--nested">
  243. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  244. <label class="md-nav__link" for="nav-5-1">
  245. AWS
  246. </label>
  247. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  248. <label class="md-nav__title" for="nav-5-1">
  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/" title="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/" title="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-toggle md-nav__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. </label>
  270. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  271. <label class="md-nav__title" for="nav-5-2">
  272. Azure
  273. </label>
  274. <ul class="md-nav__list" data-md-scrollfix>
  275. <li class="md-nav__item">
  276. <a href="provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  277. Key Vault
  278. </a>
  279. </li>
  280. </ul>
  281. </nav>
  282. </li>
  283. <li class="md-nav__item md-nav__item--nested">
  284. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  285. <label class="md-nav__link" for="nav-5-3">
  286. Google
  287. </label>
  288. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  289. <label class="md-nav__title" for="nav-5-3">
  290. Google
  291. </label>
  292. <ul class="md-nav__list" data-md-scrollfix>
  293. <li class="md-nav__item">
  294. <a href="provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  295. Secrets Manager
  296. </a>
  297. </li>
  298. </ul>
  299. </nav>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  303. HashiCorp Vault
  304. </a>
  305. </li>
  306. </ul>
  307. </nav>
  308. </li>
  309. <li class="md-nav__item md-nav__item--nested">
  310. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  311. <label class="md-nav__link" for="nav-6">
  312. References
  313. </label>
  314. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  315. <label class="md-nav__title" for="nav-6">
  316. References
  317. </label>
  318. <ul class="md-nav__list" data-md-scrollfix>
  319. <li class="md-nav__item">
  320. <a href="spec/" title="API specification" class="md-nav__link">
  321. API specification
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  329. <label class="md-nav__link" for="nav-7">
  330. Contributing
  331. </label>
  332. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  333. <label class="md-nav__title" for="nav-7">
  334. Contributing
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="contributing-devguide/" title="Developer guide" class="md-nav__link">
  339. Developer guide
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="contributing-process/" title="Contributing Process" class="md-nav__link">
  344. Contributing Process
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="contributing-coc/" title="Code of Conduct" class="md-nav__link">
  349. Code of Conduct
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. </ul>
  356. </nav>
  357. </div>
  358. </div>
  359. </div>
  360. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  361. <div class="md-sidebar__scrollwrap">
  362. <div class="md-sidebar__inner">
  363. <nav class="md-nav md-nav--secondary">
  364. <label class="md-nav__title" for="__toc">Table of contents</label>
  365. <ul class="md-nav__list" data-md-scrollfix>
  366. <li class="md-nav__item">
  367. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  368. What is the goal of External Secrets Operator?
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="#where-to-get-started" class="md-nav__link">
  373. Where to get started
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="#how-to-get-involved" class="md-nav__link">
  378. How to get involved
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="#kicked-off-by" class="md-nav__link">
  383. Kicked off by
  384. </a>
  385. </li>
  386. </ul>
  387. </nav>
  388. </div>
  389. </div>
  390. </div>
  391. <div class="md-content">
  392. <article class="md-content__inner md-typeset">
  393. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/index.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  394. <h1 id="introduction">Introduction</h1>
  395. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  396. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  397. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  398. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  399. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  400. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  401. Vault</a> and many more. The
  402. operator reads information from external APIs and automatically injects the
  403. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  404. Secret</a>.</p>
  405. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  406. <p>The goal of External Secrets Operator is to synchronize secrets from external
  407. APIs into Kubernetes. ESO is a collection of custom API resources -
  408. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  409. user-friendly abstraction for the external API that stores and manages the
  410. lifecycle of the secrets for you.</p>
  411. <h3 id="where-to-get-started">Where to get started</h3>
  412. <p>To get started, please read through <a href="api-overview/">API overview</a> this should
  413. give you a high-level overview to understand the API and use-cases. After that
  414. please follow one of our <a href="guides-introduction/">guides</a> to get a jump start
  415. using the operator.</p>
  416. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  417. Reference</a>.</p>
  418. <h3 id="how-to-get-involved">How to get involved</h3>
  419. <p>This project is driven by it's users and contributors and we welcome everybody
  420. to get involved. Join our meetings, open issues or ask questions in Slack. The
  421. success of this project depends on your input: No contribution is too small -
  422. even opinions matter!</p>
  423. <p>How to get involved:</p>
  424. <ul>
  425. <li>Monthly Meeting: we announce our meetings on slack
  426. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>)</li>
  427. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  428. #external-secrets</a></li>
  429. <li><a href="contributing-process/">Contributing Process</a></li>
  430. </ul>
  431. <h3 id="kicked-off-by">Kicked off by</h3>
  432. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  433. <img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  434. </article>
  435. </div>
  436. </div>
  437. </main>
  438. <footer class="md-footer">
  439. <div class="md-footer-nav">
  440. <nav class="md-footer-nav__inner md-grid">
  441. <a href="api-overview/" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  442. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  443. <span class="md-flex__ellipsis">
  444. <span class="md-footer-nav__direction">
  445. Next
  446. </span>
  447. Overview
  448. </span>
  449. </div>
  450. <div class="md-flex__cell md-flex__cell--shrink">
  451. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  452. </div>
  453. </a>
  454. </nav>
  455. </div>
  456. <div class="md-footer-meta md-typeset">
  457. <div class="md-footer-meta__inner md-grid">
  458. <div class="md-footer-copyright">
  459. powered by
  460. <a href="https://www.mkdocs.org">MkDocs</a>
  461. and
  462. <a href="https://squidfunk.github.io/mkdocs-material/">
  463. Material for MkDocs</a>
  464. </div>
  465. </div>
  466. </div>
  467. </footer>
  468. </div>
  469. <script src="assets/javascripts/application.808e90bb.js"></script>
  470. <script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
  471. </body>
  472. </html>