index.html 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025
  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>Getting started - 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="#getting-started" 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. Getting started
  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">
  128. <a href=".." title="Introduction" class="md-nav__link">
  129. Introduction
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="../api-overview/" title="Overview" class="md-nav__link">
  134. Overview
  135. </a>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
  139. <label class="md-nav__link" for="nav-3">
  140. API Types
  141. </label>
  142. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  143. <label class="md-nav__title" for="nav-3">
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. </ul>
  163. </nav>
  164. </li>
  165. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  166. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
  167. <label class="md-nav__link" for="nav-4">
  168. Guides
  169. </label>
  170. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  171. <label class="md-nav__title" for="nav-4">
  172. Guides
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  177. Introduction
  178. </a>
  179. </li>
  180. <li class="md-nav__item md-nav__item--active">
  181. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  182. <label class="md-nav__link md-nav__link--active" for="__toc">
  183. Getting started
  184. </label>
  185. <a href="./" title="Getting started" class="md-nav__link md-nav__link--active">
  186. Getting started
  187. </a>
  188. <nav class="md-nav md-nav--secondary">
  189. <label class="md-nav__title" for="__toc">Table of contents</label>
  190. <ul class="md-nav__list" data-md-scrollfix>
  191. <li class="md-nav__item">
  192. <a href="#installing-with-helm" class="md-nav__link">
  193. Installing with Helm
  194. </a>
  195. <nav class="md-nav">
  196. <ul class="md-nav__list">
  197. <li class="md-nav__item">
  198. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  199. Option 1: Install from chart repository
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  204. Option 2: Install chart from local build
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  209. Create a secret containing your AWS credentials
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="#create-your-first-secretstore" class="md-nav__link">
  214. Create your first SecretStore
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="#create-your-first-externalsecret" class="md-nav__link">
  219. Create your first ExternalSecret
  220. </a>
  221. </li>
  222. </ul>
  223. </nav>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="#uninstalling" class="md-nav__link">
  227. Uninstalling
  228. </a>
  229. <nav class="md-nav">
  230. <ul class="md-nav__list">
  231. <li class="md-nav__item">
  232. <a href="#uninstalling-with-helm" class="md-nav__link">
  233. Uninstalling with Helm
  234. </a>
  235. </li>
  236. </ul>
  237. </nav>
  238. </li>
  239. </ul>
  240. </nav>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  244. Advanced Templating
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  249. Multi Tenancy
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../guides-metrics/" title="Metrics" class="md-nav__link">
  254. Metrics
  255. </a>
  256. </li>
  257. </ul>
  258. </nav>
  259. </li>
  260. <li class="md-nav__item md-nav__item--nested">
  261. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  262. <label class="md-nav__link" for="nav-5">
  263. Provider
  264. </label>
  265. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  266. <label class="md-nav__title" for="nav-5">
  267. Provider
  268. </label>
  269. <ul class="md-nav__list" data-md-scrollfix>
  270. <li class="md-nav__item md-nav__item--nested">
  271. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  272. <label class="md-nav__link" for="nav-5-1">
  273. AWS
  274. </label>
  275. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  276. <label class="md-nav__title" for="nav-5-1">
  277. AWS
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item">
  281. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  282. Secrets Manager
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../provider-aws-parameter-store/" title="Parameter Store" class="md-nav__link">
  287. Parameter Store
  288. </a>
  289. </li>
  290. </ul>
  291. </nav>
  292. </li>
  293. <li class="md-nav__item md-nav__item--nested">
  294. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  295. <label class="md-nav__link" for="nav-5-2">
  296. Azure
  297. </label>
  298. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  299. <label class="md-nav__title" for="nav-5-2">
  300. Azure
  301. </label>
  302. <ul class="md-nav__list" data-md-scrollfix>
  303. <li class="md-nav__item">
  304. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  305. Key Vault
  306. </a>
  307. </li>
  308. </ul>
  309. </nav>
  310. </li>
  311. <li class="md-nav__item md-nav__item--nested">
  312. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  313. <label class="md-nav__link" for="nav-5-3">
  314. Google
  315. </label>
  316. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  317. <label class="md-nav__title" for="nav-5-3">
  318. Google
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item">
  322. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  323. Secrets Manager
  324. </a>
  325. </li>
  326. </ul>
  327. </nav>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  331. HashiCorp Vault
  332. </a>
  333. </li>
  334. </ul>
  335. </nav>
  336. </li>
  337. <li class="md-nav__item md-nav__item--nested">
  338. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  339. <label class="md-nav__link" for="nav-6">
  340. References
  341. </label>
  342. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  343. <label class="md-nav__title" for="nav-6">
  344. References
  345. </label>
  346. <ul class="md-nav__list" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="../spec/" title="API specification" class="md-nav__link">
  349. API specification
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  357. <label class="md-nav__link" for="nav-7">
  358. Contributing
  359. </label>
  360. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  361. <label class="md-nav__title" for="nav-7">
  362. Contributing
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  367. Developer guide
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../contributing-process/" title="Contributing Process" class="md-nav__link">
  372. Contributing Process
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  377. Code of Conduct
  378. </a>
  379. </li>
  380. </ul>
  381. </nav>
  382. </li>
  383. </ul>
  384. </nav>
  385. </div>
  386. </div>
  387. </div>
  388. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  389. <div class="md-sidebar__scrollwrap">
  390. <div class="md-sidebar__inner">
  391. <nav class="md-nav md-nav--secondary">
  392. <label class="md-nav__title" for="__toc">Table of contents</label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="#installing-with-helm" class="md-nav__link">
  396. Installing with Helm
  397. </a>
  398. <nav class="md-nav">
  399. <ul class="md-nav__list">
  400. <li class="md-nav__item">
  401. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  402. Option 1: Install from chart repository
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  407. Option 2: Install chart from local build
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  412. Create a secret containing your AWS credentials
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="#create-your-first-secretstore" class="md-nav__link">
  417. Create your first SecretStore
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="#create-your-first-externalsecret" class="md-nav__link">
  422. Create your first ExternalSecret
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="#uninstalling" class="md-nav__link">
  430. Uninstalling
  431. </a>
  432. <nav class="md-nav">
  433. <ul class="md-nav__list">
  434. <li class="md-nav__item">
  435. <a href="#uninstalling-with-helm" class="md-nav__link">
  436. Uninstalling with Helm
  437. </a>
  438. </li>
  439. </ul>
  440. </nav>
  441. </li>
  442. </ul>
  443. </nav>
  444. </div>
  445. </div>
  446. </div>
  447. <div class="md-content">
  448. <article class="md-content__inner md-typeset">
  449. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-getting-started.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  450. <h1 id="getting-started">Getting started</h1>
  451. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  452. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  453. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  454. <blockquote>
  455. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  456. to a supported version before installing external-secrets.</p>
  457. </blockquote>
  458. <h2 id="installing-with-helm">Installing with Helm</h2>
  459. <p>To automatically install and manage the CRDs as part of your Helm release, you must add the --set installCRDs=true flag to your Helm installation command.</p>
  460. <p>Uncomment the relevant line in the next steps to enable this.</p>
  461. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  462. <div class="highlight"><pre><span></span>helm repo add external-secrets https://charts.external-secrets.io
  463. helm install external-secrets <span class="se">\</span>
  464. external-secrets/external-secrets <span class="se">\</span>
  465. -n external-secrets <span class="se">\</span>
  466. --create-namespace <span class="se">\</span>
  467. <span class="c1"># --set installCRDs=true</span>
  468. </pre></div>
  469. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  470. <p>Build and install the Helm chart locally after cloning the repository.</p>
  471. <div class="highlight"><pre><span></span>make helm.build
  472. helm install external-secrets <span class="se">\</span>
  473. ./bin/chart/external-secrets.tgz <span class="se">\</span>
  474. -n external-secrets <span class="se">\</span>
  475. --create-namespace <span class="se">\</span>
  476. <span class="c1"># --set installCRDs=true</span>
  477. </pre></div>
  478. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  479. <div class="highlight"><pre><span></span><span class="nb">echo</span> -n <span class="s1">&#39;KEYID&#39;</span> &gt; ./access-key
  480. <span class="nb">echo</span> -n <span class="s1">&#39;SECRETKEY&#39;</span> &gt; ./secret-access-key
  481. kubectl create secret generic awssm-secret --from-file<span class="o">=</span>./access-key --from-file<span class="o">=</span>./secret-access-key
  482. </pre></div>
  483. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  484. <div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  485. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  486. <span class="nt">metadata</span><span class="p">:</span>
  487. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  488. <span class="nt">spec</span><span class="p">:</span>
  489. <span class="nt">controller</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev</span>
  490. <span class="nt">provider</span><span class="p">:</span>
  491. <span class="nt">aws</span><span class="p">:</span>
  492. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  493. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/team-a-reader</span>
  494. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">us-east-1</span>
  495. <span class="nt">auth</span><span class="p">:</span>
  496. <span class="nt">secretRef</span><span class="p">:</span>
  497. <span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  498. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  499. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">access-key</span>
  500. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  501. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  502. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  503. </pre></div>
  504. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  505. <div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  506. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  507. <span class="nt">metadata</span><span class="p">:</span>
  508. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  509. <span class="nt">spec</span><span class="p">:</span>
  510. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  511. <span class="nt">secretStoreRef</span><span class="p">:</span>
  512. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  513. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  514. <span class="nt">target</span><span class="p">:</span>
  515. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
  516. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  517. <span class="nt">data</span><span class="p">:</span>
  518. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-key-to-be-managed</span>
  519. <span class="nt">remoteRef</span><span class="p">:</span>
  520. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key</span>
  521. <span class="nt">version</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-version</span>
  522. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-property</span>
  523. <span class="nt">dataFrom</span><span class="p">:</span>
  524. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">remote-key-in-the-provider</span>
  525. </pre></div>
  526. <div class="highlight"><pre><span></span>kubectl describe externalsecret example
  527. <span class="c1"># [...]</span>
  528. Name: example
  529. Status:
  530. Conditions:
  531. Last Transition Time: <span class="m">2021</span>-02-24T16:45:23Z
  532. Message: Secret was synced
  533. Reason: SecretSynced
  534. Status: True
  535. Type: Ready
  536. Refresh Time: <span class="m">2021</span>-02-24T16:45:24Z
  537. Events: &lt;none&gt;
  538. </pre></div>
  539. <p>For more advanced examples, please read the other
  540. <a href="../guides-introduction/">guides</a>.</p>
  541. <h2 id="uninstalling">Uninstalling</h2>
  542. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  543. You can check for any existing resources with the following command:</p>
  544. <div class="highlight"><pre><span></span>kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces
  545. </pre></div>
  546. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  547. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  548. <p>Uninstall the helm release using the delete command.</p>
  549. <div class="highlight"><pre><span></span>helm delete external-secrets --namespace external-secrets
  550. </pre></div>
  551. </article>
  552. </div>
  553. </div>
  554. </main>
  555. <footer class="md-footer">
  556. <div class="md-footer-nav">
  557. <nav class="md-footer-nav__inner md-grid">
  558. <a href="../guides-introduction/" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  559. <div class="md-flex__cell md-flex__cell--shrink">
  560. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  561. </div>
  562. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  563. <span class="md-flex__ellipsis">
  564. <span class="md-footer-nav__direction">
  565. Previous
  566. </span>
  567. Introduction
  568. </span>
  569. </div>
  570. </a>
  571. <a href="../guides-templating/" title="Advanced Templating" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  572. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  573. <span class="md-flex__ellipsis">
  574. <span class="md-footer-nav__direction">
  575. Next
  576. </span>
  577. Advanced Templating
  578. </span>
  579. </div>
  580. <div class="md-flex__cell md-flex__cell--shrink">
  581. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  582. </div>
  583. </a>
  584. </nav>
  585. </div>
  586. <div class="md-footer-meta md-typeset">
  587. <div class="md-footer-meta__inner md-grid">
  588. <div class="md-footer-copyright">
  589. powered by
  590. <a href="https://www.mkdocs.org">MkDocs</a>
  591. and
  592. <a href="https://squidfunk.github.io/mkdocs-material/">
  593. Material for MkDocs</a>
  594. </div>
  595. </div>
  596. </div>
  597. </footer>
  598. </div>
  599. <script src="../assets/javascripts/application.808e90bb.js"></script>
  600. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  601. </body>
  602. </html>