| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328 |
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
-
- <link rel="icon" href="../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
-
-
-
- <title>Key Vault - External Secrets Operator</title>
-
-
-
- <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
-
-
- <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
- <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
-
-
-
-
-
-
-
-
-
- <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
- <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
-
-
- </head>
-
-
-
-
-
-
-
- <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
-
-
- <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
-
- <a href="#azure-key-vault" class="md-skip">
- Skip to content
- </a>
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <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>
- </a>
- <label class="md-header__button md-icon" for="__drawer">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- External Secrets Operator
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- Key Vault
-
- </span>
- </div>
- </div>
- </div>
-
-
-
- <label class="md-header__button md-icon" for="__search">
- <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>
- </label>
-
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <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" data-md-state="active" required>
- <label class="md-search__icon md-icon" for="__search">
- <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>
- <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>
- </label>
- <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
- <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>
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
- <div class="md-header__source">
-
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- </nav>
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <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>
- </a>
- External Secrets Operator
- </label>
-
- <div class="md-nav__source">
-
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href=".." class="md-nav__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-overview/" class="md-nav__link">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
-
- <label class="md-nav__link" for="__nav_3">
- API Types
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="API Types" data-md-level="1">
- <label class="md-nav__title" for="__nav_3">
- <span class="md-nav__icon md-icon"></span>
- API Types
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-externalsecret/" class="md-nav__link">
- ExternalSecret
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-secretstore/" class="md-nav__link">
- SecretStore
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-clustersecretstore/" class="md-nav__link">
- ClusterSecretStore
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
-
- <label class="md-nav__link" for="__nav_4">
- Guides
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Guides" data-md-level="1">
- <label class="md-nav__title" for="__nav_4">
- <span class="md-nav__icon md-icon"></span>
- Guides
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-introduction/" class="md-nav__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-getting-started/" class="md-nav__link">
- Getting started
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-templating/" class="md-nav__link">
- Advanced Templating
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-controller-class/" class="md-nav__link">
- Controller Classes
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-all-keys-one-secret/" class="md-nav__link">
- All keys, One secret
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
- Common K8S Secret Types
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-multi-tenancy/" class="md-nav__link">
- Multi Tenancy
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-metrics/" class="md-nav__link">
- Metrics
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-using-latest-image/" class="md-nav__link">
- Using Latest Image
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
- GitOps using FluxCD
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
-
- <label class="md-nav__link" for="__nav_5">
- Provider
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Provider" data-md-level="1">
- <label class="md-nav__title" for="__nav_5">
- <span class="md-nav__icon md-icon"></span>
- Provider
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
-
- <label class="md-nav__link" for="__nav_5_1">
- AWS
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="AWS" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_1">
- <span class="md-nav__icon md-icon"></span>
- AWS
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-aws-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-aws-parameter-store/" class="md-nav__link">
- Parameter Store
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
-
- <label class="md-nav__link" for="__nav_5_2">
- Azure
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Azure" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_2">
- <span class="md-nav__icon md-icon"></span>
- Azure
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
- Key Vault
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <a href="./" class="md-nav__link md-nav__link--active">
- Key Vault
- </a>
-
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#azure-key-vault" class="md-nav__link">
- Azure Key vault
- </a>
-
- <nav class="md-nav" aria-label="Azure Key vault">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#authentication" class="md-nav__link">
- Authentication
- </a>
-
- <nav class="md-nav" aria-label="Authentication">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#service-principal-key-authentication" class="md-nav__link">
- Service Principal key authentication
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#managed-identity-authentication" class="md-nav__link">
- Managed Identity authentication
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#update-secret-store" class="md-nav__link">
- Update secret store
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#object-types" class="md-nav__link">
- Object Types
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#creating-external-secret" class="md-nav__link">
- Creating external secret
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
-
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
-
- <label class="md-nav__link" for="__nav_5_3">
- Google
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Google" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_3">
- <span class="md-nav__icon md-icon"></span>
- Google
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-google-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
-
- <label class="md-nav__link" for="__nav_5_4">
- IBM
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="IBM" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_4">
- <span class="md-nav__icon md-icon"></span>
- IBM
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-akeyless/" class="md-nav__link">
- Akeyless
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-hashicorp-vault/" class="md-nav__link">
- HashiCorp Vault
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
-
- <label class="md-nav__link" for="__nav_5_7">
- Yandex
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Yandex" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_7">
- <span class="md-nav__icon md-icon"></span>
- Yandex
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-yandex-lockbox/" class="md-nav__link">
- Lockbox
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
-
- <label class="md-nav__link" for="__nav_5_8">
- Gitlab
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_8">
- <span class="md-nav__icon md-icon"></span>
- Gitlab
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-gitlab-project-variables/" class="md-nav__link">
- Gitlab Project Variables
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
-
- <label class="md-nav__link" for="__nav_5_9">
- Oracle
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Oracle" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_9">
- <span class="md-nav__icon md-icon"></span>
- Oracle
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-oracle-vault/" class="md-nav__link">
- Oracle Vault
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-webhook/" class="md-nav__link">
- Webhook
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
-
- <label class="md-nav__link" for="__nav_6">
- References
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="References" data-md-level="1">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
- References
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../spec/" class="md-nav__link">
- API specification
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
-
- <label class="md-nav__link" for="__nav_7">
- Contributing
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Contributing" data-md-level="1">
- <label class="md-nav__title" for="__nav_7">
- <span class="md-nav__icon md-icon"></span>
- Contributing
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-devguide/" class="md-nav__link">
- Developer guide
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-process/" class="md-nav__link">
- Contributing Process
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-coc/" class="md-nav__link">
- Code of Conduct
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../deprecation-policy/" class="md-nav__link">
- Deprecation Policy
- </a>
- </li>
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#azure-key-vault" class="md-nav__link">
- Azure Key vault
- </a>
-
- <nav class="md-nav" aria-label="Azure Key vault">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#authentication" class="md-nav__link">
- Authentication
- </a>
-
- <nav class="md-nav" aria-label="Authentication">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#service-principal-key-authentication" class="md-nav__link">
- Service Principal key authentication
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#managed-identity-authentication" class="md-nav__link">
- Managed Identity authentication
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#update-secret-store" class="md-nav__link">
- Update secret store
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#object-types" class="md-nav__link">
- Object Types
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#creating-external-secret" class="md-nav__link">
- Creating external secret
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
- </div>
- </div>
- </div>
-
-
- <div class="md-content" data-md-component="content">
- <article class="md-content__inner md-typeset">
-
-
- <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-azure-key-vault.md" title="Edit this page" class="md-content__button md-icon">
- <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>
- </a>
-
-
- <h1>Key Vault</h1>
-
- <p><img alt="aws sm" src="../pictures/eso-az-kv-azure-kv.png" /></p>
- <h2 id="azure-key-vault">Azure Key vault</h2>
- <p>External Secrets Operator integrates with <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key vault</a> for secrets, certificates and Keys management.</p>
- <h3 id="authentication">Authentication</h3>
- <p>We support Service Principals and Managed Identity <a href="https://docs.microsoft.com/en-us/azure/key-vault/general/authentication">authentication</a>.</p>
- <p>To use Managed Identity authentication, you should use <a href="https://azure.github.io/aad-pod-identity/docs/">aad-pod-identity</a> to assign the identity to external-secrets operator. To add the selector to external-secrets operator, use <code>podLabels</code> in your values.yaml in case of Helm installation of external-secrets.</p>
- <h4 id="service-principal-key-authentication">Service Principal key authentication</h4>
- <p>A service Principal client and Secret is created and the JSON keyfile is stored in a <code>Kind=Secret</code>. The <code>ClientID</code> and <code>ClientSecret</code> should be configured for the secret. This service principal should have proper access rights to the keyvault to be managed by the operator</p>
- <h4 id="managed-identity-authentication">Managed Identity authentication</h4>
- <p>A Managed Identity should be created in Azure, and that Identity should have proper rights to the keyvault to be managed by the operator.</p>
- <p>If there are multiple Managed Identitites for different keyvaults, the operator should have been assigned all identities via <a href="https://azure.github.io/aad-pod-identity/docs/">aad-pod-identity</a>, then the SecretStore configuration should include the Id of the idenetity to be used via the <code>identityId</code> field.</p>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
- <span class="nt">metadata</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
- <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Opaque</span>
- <span class="nt">data</span><span class="p">:</span>
- <span class="nt">ClientID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bXktc2VydmljZS1wcmluY2lwbGUtY2xpZW50LWlkCg==</span> <span class="c1">#service-principal-ID</span>
- <span class="nt">ClientSecret</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bXktc2VydmljZS1wcmluY2lwbGUtY2xpZW50LXNlY3JldAo=</span> <span class="c1">#service-principal-secret</span>
- </code></pre></div>
- <h3 id="update-secret-store">Update secret store</h3>
- <p>Be sure the <code>azurekv</code> provider is listed in the <code>Kind=SecretStore</code></p>
- <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>
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="nt">provider</span><span class="p">:</span>
- <span class="c1"># provider type: azure keyvault</span>
- <span class="nt">azurekv</span><span class="p">:</span>
- <span class="c1"># azure tenant ID, see: https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant</span>
- <span class="nt">tenantId</span><span class="p">:</span> <span class="s">"d3bc2180-xxxx-xxxx-xxxx-154105743342"</span>
- <span class="c1"># URL of your vault instance, see: https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates</span>
- <span class="nt">vaultUrl</span><span class="p">:</span> <span class="s">"https://my-keyvault-name.vault.azure.net"</span>
- <span class="nt">authSecretRef</span><span class="p">:</span>
- <span class="c1"># points to the secret that contains</span>
- <span class="c1"># the azure service principal credentials</span>
- <span class="nt">clientId</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClientID</span>
- <span class="nt">clientSecret</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClientSecret</span>
- </code></pre></div>
- <p>Or in case of Managed Idenetity authentication:</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="nt">provider</span><span class="p">:</span>
- <span class="c1"># provider type: azure keyvault</span>
- <span class="nt">azurekv</span><span class="p">:</span>
- <span class="nt">authType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ManagedIdentity</span>
- <span class="c1"># Optionally set the Id of the Managed Identity, if multiple identities are assigned to external-secrets operator</span>
- <span class="nt">identityId</span><span class="p">:</span> <span class="s">"<MI_clientId>"</span>
- <span class="c1"># URL of your vault instance, see: https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates</span>
- <span class="nt">vaultUrl</span><span class="p">:</span> <span class="s">"https://my-keyvault-name.vault.azure.net"</span>
- </code></pre></div>
- <h3 id="object-types">Object Types</h3>
- <p>Azure KeyVault manages different <a href="https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#object-types">object types</a>, we support <code>keys</code>, <code>secrets</code> and <code>certificates</code>. Simply prefix the key with <code>key</code>, <code>secret</code> or <code>cert</code> to retrieve the desired type (defaults to secret).</p>
- <table>
- <thead>
- <tr>
- <th>Object Type</th>
- <th>Return Value</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>secret</code></td>
- <td>the raw secret value.</td>
- </tr>
- <tr>
- <td><code>key</code></td>
- <td>A JWK which contains the public key. Azure KeyVault does <strong>not</strong> export the private key. You may want to use <a href="../guides-templating/">template functions</a> to transform this JWK into PEM encoded PKIX ASN.1 DER format.</td>
- </tr>
- <tr>
- <td><code>certificate</code></td>
- <td>The raw CER contents of the x509 certificate. You may want to use <a href="../guides-templating/">template functions</a> to transform this into your desired encoding</td>
- </tr>
- </tbody>
- </table>
- <h3 id="creating-external-secret">Creating external secret</h3>
- <p>To create a kubernetes secret from the Azure Key vault secret a <code>Kind=ExternalSecret</code> is needed.</p>
- <p>You can manage keys/secrets/certificates saved inside the keyvault , by setting a "/" prefixed type in the secret name , the default type is a <code>secret</code>. other supported values are <code>cert</code> and <code>key</code></p>
- <p>to select all secrets inside the key vault , you can use the <code>dataFrom</code> directive</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-external-secret</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
- <span class="nt">secretStoreRef</span><span class="p">:</span>
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
- <span class="nt">target</span><span class="p">:</span>
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
- <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
- <span class="nt">data</span><span class="p">:</span>
- <span class="c1"># name of the SECRET in the Azure KV (no prefix is by default a SECRET)</span>
- <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span>
- <span class="nt">remoteRef</span><span class="p">:</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span>
- <span class="c1"># explicit type and name of secret in the Azure KV</span>
- <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-another-secret-test</span>
- <span class="nt">remoteRef</span><span class="p">:</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret/dev-secret-test</span>
- <span class="c1"># type/name of certificate in the Azure KV</span>
- <span class="c1"># raw value will be returned, use templating features for data processing</span>
- <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-cert-test</span>
- <span class="nt">remoteRef</span><span class="p">:</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">cert/dev-cert-test</span>
- <span class="c1"># type/name of the public key in the Azure KV</span>
- <span class="c1"># the key is returned PEM encoded</span>
- <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-key-test</span>
- <span class="nt">remoteRef</span><span class="p">:</span>
- <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">key/dev-key-test</span>
- </code></pre></div>
- <p>The operator will fetch the Azure Key vault secret and inject it as a <code>Kind=Secret</code>
- <div class="highlight"><pre><span></span><code>kubectl get secret secret-to-be-created -n <namespace> | -o jsonpath='{.data.dev-secret-test}' | base64 -d
- </code></pre></div></p>
-
-
-
-
-
- </article>
- </div>
- </div>
-
- </main>
-
-
- <footer class="md-footer">
-
- <nav class="md-footer__inner md-grid" aria-label="Footer">
-
-
- <a href="../provider-aws-parameter-store/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Parameter Store" rel="prev">
- <div class="md-footer__button md-icon">
- <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>
- </div>
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Previous
- </span>
- Parameter Store
- </div>
- </div>
- </a>
-
-
-
- <a href="../provider-google-secrets-manager/" class="md-footer__link md-footer__link--next" aria-label="Next: Secrets Manager" rel="next">
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Next
- </span>
- Secrets Manager
- </div>
- </div>
- <div class="md-footer__button md-icon">
- <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>
- </div>
- </a>
-
- </nav>
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
- <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.b0710199.min.js", "version": {"provider": "mike"}}</script>
-
-
- <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
-
-
- </body>
- </html>
|