Skip to content
Snippets Groups Projects
Verified Commit f20ede1e authored by Julien Wittouck's avatar Julien Wittouck
Browse files

:sparkles: : add EDA practice

parent 8c7cea66
Branches
No related tags found
No related merge requests found
Pipeline #54659 passed
:source-highlighter: rouge
:prewrap!:
:icons: font
:toc: left
:toclevels: 4
:linkattrs:
:sectlinks:
:sectanchors:
:sectnums:
:experimental:
:stem:
= ALOM - TP 11 - EDA !
== Présentation et objectifs
Le but est de continuer le développement de notre architecture "à la microservice".
Nous allons utiliser Apache Pulsar, pour implémenter un début d'architecture EDA entre les micro-services game et mailing.
.Notre architecture !
image::images/pokemon-archi.png[]
== Pré-requis
En pré-requis à ce TP, il faut avoir implémenté la partie https://alom-2024.gitlabpages.univ-lille.fr/cours/w09-cloud/09-tp-cloud.html#_envoi_demails[6. Envoi d'emails, role="external", window="_blank"].
== `mailing-api`
=== Démarrage d'une instance locale de pulsar
Apache Pulsar est disponible sous la forme d'une image Docker : https://hub.docker.com/r/apachepulsar/pulsar[apachepulsar/pulsar, role="external", window="_blank"].
Démarrez une instance de pulsar sur votre poste avec la commande suivante :
[source,bash]
----
docker container run -d \
--name pulsar \
-p 6650:6650 \
-p 6080:8080 \
apachepulsar/pulsar:4.0.1 \
bin/pulsar standalone
----
=== Configuration Spring Boot
Dans votre projet `mailing`, importez la dépendance `spring-boot-starter-pulsar` :
[source,xml]
.pom.xml
----
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-pulsar</artifactId>
</dependency>
----
Configurez les properties suivantes dans un fichier `application-local.properties`, pour utiliser votre instance locale :
[source,properties]
.application-local.properties
----
spring.pulsar.client.service-url=pulsar://localhost:6650
spring.pulsar.admin.service-url=http://localhost:6080
----
=== Ajout d'un listener
Créez une classe ou un record qui représentera votre évènement `trainer:new`.
Cette classe contient l'adresse mail du trainer, ainsi que son nom.
Annotez cette classe avec l'annotation `@PulsarMessage(schemaType = SchemaType.JSON)` pour indiquer à Spring Boot que cet objet devra être sérialisé en JSON.
Implémentez une classe `NewTrainerEventPulsarAdapter`.
L'annotation `@PulsarListener` permet de marquer une méthode Java comme devant être appelée lorsqu'un message est disponible dans un topic Pulsar.
Ajoutez une méthode à cette classe, qui porte l'annotation, et reçoit en paramètre votre classe d'évènement :
[source,java]
----
@PulsarListener(topics = "trainer:new", subscriptionType = SubscriptionType.Shared)
void receiveEvent(NewTrainerEvent event) {
// TODO
}
----
Cette méthode écoute sur un topic `<votre-nom>:trainer:new`.
NOTE: On utilise un nommage de topic `trainer:new` avec votre nom en préfixe, pour éviter les conflits entre les étudiants !
Le paramètre `SubscriptionType.Shared` permet de partager la connexion au topic entre plusieurs instances de votre micro-service !
Cette méthode pourra appeler la méthode de service existant par ailleurs.
Le démarrage de votre application devrait afficher les logs de connexion au topic pulsar :
[source]
----
o.a.p.c.impl.ConsumerStatsRecorderImpl : Starting Pulsar consumer status recorder with config: {"topicNames":["persistent://public/default/new-trainer"],"topicsPattern":null,"subscriptionName":"org.springframework.Pulsar.PulsarListenerEndpointContainer#0","subscriptionType":"Shared","subscriptionProperties":null,"subscriptionMode":"Durable","receiverQueueSize":1000,"acknowledgementsGroupTimeMicros":100000,"maxAcknowledgmentGroupSize":1000,"negativeAckRedeliveryDelayMicros":60000000,"maxTotalReceiverQueueSizeAcrossPartitions":50000,"consumerName":null,"ackTimeoutMillis":0,"tickDurationMillis":1000,"priorityLevel":0,"maxPendingChunkedMessage":10,"autoAckOldestChunkedMessageOnQueueFull":false,"expireTimeOfIncompleteChunkedMessageMillis":60000,"cryptoFailureAction":"FAIL","properties":{},"readCompacted":false,"subscriptionInitialPosition":"Latest","patternAutoDiscoveryPeriod":60,"regexSubscriptionMode":"PersistentOnly","deadLetterPolicy":null,"retryEnable":false,"autoUpdatePartitions":true,"autoUpdatePartitionsIntervalSeconds":60,"replicateSubscriptionState":false,"resetIncludeHead":false,"batchIndexAckEnabled":false,"ackReceiptEnabled":false,"poolMessages":false,"startPaused":false,"autoScaledReceiverQueueSizeEnabled":false,"topicConfigurations":[],"maxPendingChuckedMessage":10}
o.a.p.c.impl.ConsumerStatsRecorderImpl : Pulsar client config: {"serviceUrl":"pulsar://localhost:6650","authPluginClassName":null,"authParams":null,"authParamMap":null,"operationTimeoutMs":30000,"lookupTimeoutMs":30000,"statsIntervalSeconds":60,"numIoThreads":22,"numListenerThreads":22,"connectionsPerBroker":1,"connectionMaxIdleSeconds":25,"useTcpNoDelay":true,"useTls":false,"tlsKeyFilePath":null,"tlsCertificateFilePath":null,"tlsTrustCertsFilePath":null,"tlsAllowInsecureConnection":false,"tlsHostnameVerificationEnable":false,"concurrentLookupRequest":5000,"maxLookupRequest":50000,"maxLookupRedirects":20,"maxNumberOfRejectedRequestPerConnection":50,"keepAliveIntervalSeconds":30,"connectionTimeoutMs":10000,"requestTimeoutMs":60000,"readTimeoutMs":60000,"autoCertRefreshSeconds":300,"initialBackoffIntervalNanos":100000000,"maxBackoffIntervalNanos":60000000000,"enableBusyWait":false,"listenerName":null,"useKeyStoreTls":false,"sslProvider":null,"tlsKeyStoreType":"JKS","tlsKeyStorePath":null,"tlsKeyStorePassword":null,"tlsTrustStoreType":"JKS","tlsTrustStorePath":null,"tlsTrustStorePassword":null,"tlsCiphers":[],"tlsProtocols":[],"memoryLimitBytes":67108864,"proxyServiceUrl":null,"proxyProtocol":null,"enableTransaction":false,"dnsLookupBindAddress":null,"dnsLookupBindPort":0,"dnsServerAddresses":[],"socks5ProxyAddress":null,"socks5ProxyUsername":null,"socks5ProxyPassword":null,"description":null,"openTelemetry":null}
o.a.pulsar.client.impl.ConsumerImpl : [persistent://public/default/trainer:new][org.springframework.Pulsar.PulsarListenerEndpointContainer#0] Subscribing to topic on cnx [id: 0x58864231, L:/127.0.0.1:38618 - R:localhost/127.0.0.1:6650], consumerId 0
o.a.pulsar.client.impl.ConsumerImpl : [persistent://public/default/trainer:new][org.springframework.Pulsar.PulsarListenerEndpointContainer#0] Subscribed to topic on localhost/127.0.0.1:6650 -- consumer: 0
----
Implémentez toutes les méthodes disponibles sur le mailing service avec des listener Pulsar :
* envoi d'un email de bienvenue (reçoit le nom d’un Trainer en paramètre, ainsi que son email)
* envoi d'un email de fin de combat (reçoit les noms des 2 adversaires, leurs emails, et l’information de qui a gagné le combat)
== `trainer-api`
=== Configuration
Ajoutez la dépendance `spring-boot-starter-pulsar` à votre projet `trainer-ui`.
Configurez les properties suivantes dans un fichier `application-local.properties`, pour utiliser votre instance locale :
[source,properties]
.application-local.properties
----
spring.pulsar.client.service-url=pulsar://localhost:6650
spring.pulsar.admin.service-url=http://localhost:6080
----
=== Ajout d'un producer
Spring propose un `PulsarTemplate` pour poster des messages dans un topic.
Dans une classe de `game-ui`, nommée `UserEventsPulsarAdapter`, utilisez le `PulsarTemplate` (reçu en injection de dépendance) pour envoyer les évènements à destination du `mailing-api` dans le topic consacré `<votre-nom>:trainer:new`.
À titre d'exemple, voici un usage du `PulsarTemplate` pour envoyer un message sur un topic :
[source,java]
----
pulsarTemplate.send(
"trainer:new",
new NewTrainerEvent("Ash", "ash@gitlab-classrooms.org")
);
----
TIP: N'hésitez pas à copier/coller votre classe correspondant à l'évènement attendu depuis `mailing-api`.
TIP: Isolez toutes ces classes dans un package consacré. Vous pouvez aussi exposer une interface `UserEventsPort` dans votre couche "domaine" si elle existe, pour reprendre les principes de l'architecture hexagonale.
== `battle-api`
Dans `battle-api`, implémentez l'envoi d'un message lors de la fin d'un combat, à destination du `mailing-api` dans le topic consacré `<votre-nom>:battle:end`, de la même manière que cela a été fait entre `game-ui` et `mailing-api`.
== Configuration pour Clever Cloud
La configuration de l'utilisation de Pulsar sur Clever Cloud nécessite quelques ajustements :
* l'instance de Pulsar est partagée entre tous les étudiants
* la connexion à Pulsar nécessite une authentification
* les topics peuvent être créés dans un tenant/namespace unique
Toutes les informations nécessaires à la connexion à Pulsar sont disponibles à 2 endroits :
* dans la console https://console.clever-cloud.com/organisations/orga_d02d9099-9664-47fd-8029-d90e36628e1d/addons/addon_baad03f5-7cbd-4d52-9b86-df292644b955/services-dependencies[Clever Cloud, role="external", window="_blank"].
* dans un secret sur https://vault-alom-2024.cleverapps.io/ui/vault/secrets/secret/kv/list[Vault, role="external", window="_blank"].
.Les secrets Pulsar dans Clever Cloud
image::images/clever-pulsar.png[]
.Les secrets Pulsar dans Vault
image::images/vault-pulsar.png[]
Configurez dans vos projets `mailing-api`, `game-ui` et `battle-api` l'utilisation de l'instance Pulsar de Clever Cloud :
[source,properties]
.application-clever.properties
----
spring.pulsar.client.service-url= #<1>
spring.pulsar.client.authentication.plugin-class-name=org.apache.pulsar.client.impl.auth.AuthenticationToken
spring.pulsar.client.authentication.param.token= #<2>
spring.pulsar.admin.service-url= #<3>
spring.pulsar.admin.authentication.plugin-class-name=org.apache.pulsar.client.impl.auth.AuthenticationToken
spring.pulsar.admin.authentication.param.token= #<2>
spring.pulsar.defaults.topic.tenant= #<4>
spring.pulsar.defaults.topic.namespace= #<5>
----
1. Utilisez la valeur de `ADDON_PULSAR_BINARY_URL`
2. Utilisez la valeur de `ADDON_PULSAR_TOKEN`
3. Utilisez la valeur de `ADDON_PULSAR_HTTP_URL`
4. Utilisez la valeur de `ADDON_PULSAR_TENANT`
5. Utilisez la valeur de `ADDON_PULSAR_NAMESPACE`
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.23">
<title>ALOM - TP 11 - EDA !</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
/* Uncomment the following line when using as a custom stylesheet */
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
a{background:none}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
b,strong{font-weight:bold}
abbr{font-size:.9em}
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
dfn{font-style:italic}
hr{height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
audio,video{display:inline-block}
audio:not([controls]){display:none;height:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type=checkbox],input[type=radio]{padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,::before,::after{box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:0}
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.square{list-style-type:square}
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
:not(pre).nobreak{word-wrap:normal}
:not(pre).nowrap{white-space:nowrap}
:not(pre).pre-wrap{white-space:pre-wrap}
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre>code{display:block}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details{margin-left:1.25rem}
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
details>summary::-webkit-details-marker{display:none}
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
.listingblock>.content{position:relative}
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.prettyprint{background:#f7f7f8}
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
pre.prettyprint li code[data-lang]::before{opacity:1}
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em}
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>*>tr>*{border-width:1px}
table.grid-cols>*>tr>*{border-width:0 1px}
table.grid-rows>*>tr>*{border-width:1px 0}
table.frame-all{border-width:1px}
table.frame-ends{border-width:1px 0}
table.frame-sides{border-width:0 1px}
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
li>p:empty:only-child::before{content:"";display:inline-block}
ul.checklist>li>p:first-child{margin-left:-1em}
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
td.hdlist2{word-wrap:anywhere}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background:#00fafa}
.black{color:#000}
.black-background{background:#000}
.blue{color:#0000bf}
.blue-background{background:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background:#fa00fa}
.gray{color:#606060}
.gray-background{background:#7d7d7d}
.green{color:#006000}
.green-background{background:#007d00}
.lime{color:#00bf00}
.lime-background{background:#00fa00}
.maroon{color:#600000}
.maroon-background{background:#7d0000}
.navy{color:#000060}
.navy-background{background:#00007d}
.olive{color:#606000}
.olive-background{background:#7d7d00}
.purple{color:#600060}
.purple-background{background:#7d007d}
.red{color:#bf0000}
.red-background{background:#fa0000}
.silver{color:#909090}
.silver-background{background:#bcbcbc}
.teal{color:#006060}
.teal-background{background:#007d7d}
.white{color:#bfbfbf}
.white-background{background:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]{border-bottom:1px dotted}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#header,#content,#footnotes,#footer{max-width:none}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
</style>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<style>
pre.rouge table td { padding: 5px; }
pre.rouge table pre { margin: 0; }
pre.rouge, pre.rouge .w {
color: #24292f;
background-color: #f6f8fa;
}
pre.rouge .k, pre.rouge .kd, pre.rouge .kn, pre.rouge .kp, pre.rouge .kr, pre.rouge .kt, pre.rouge .kv {
color: #cf222e;
}
pre.rouge .gr {
color: #f6f8fa;
}
pre.rouge .gd {
color: #82071e;
background-color: #ffebe9;
}
pre.rouge .nb {
color: #953800;
}
pre.rouge .nc {
color: #953800;
}
pre.rouge .no {
color: #953800;
}
pre.rouge .nn {
color: #953800;
}
pre.rouge .sr {
color: #116329;
}
pre.rouge .na {
color: #116329;
}
pre.rouge .nt {
color: #116329;
}
pre.rouge .gi {
color: #116329;
background-color: #dafbe1;
}
pre.rouge .ges {
font-weight: bold;
font-style: italic;
}
pre.rouge .kc {
color: #0550ae;
}
pre.rouge .l, pre.rouge .ld, pre.rouge .m, pre.rouge .mb, pre.rouge .mf, pre.rouge .mh, pre.rouge .mi, pre.rouge .il, pre.rouge .mo, pre.rouge .mx {
color: #0550ae;
}
pre.rouge .sb {
color: #0550ae;
}
pre.rouge .bp {
color: #0550ae;
}
pre.rouge .ne {
color: #0550ae;
}
pre.rouge .nl {
color: #0550ae;
}
pre.rouge .py {
color: #0550ae;
}
pre.rouge .nv, pre.rouge .vc, pre.rouge .vg, pre.rouge .vi, pre.rouge .vm {
color: #0550ae;
}
pre.rouge .o, pre.rouge .ow {
color: #0550ae;
}
pre.rouge .gh {
color: #0550ae;
font-weight: bold;
}
pre.rouge .gu {
color: #0550ae;
font-weight: bold;
}
pre.rouge .s, pre.rouge .sa, pre.rouge .sc, pre.rouge .dl, pre.rouge .sd, pre.rouge .s2, pre.rouge .se, pre.rouge .sh, pre.rouge .sx, pre.rouge .s1, pre.rouge .ss {
color: #0a3069;
}
pre.rouge .nd {
color: #8250df;
}
pre.rouge .nf, pre.rouge .fm {
color: #8250df;
}
pre.rouge .err {
color: #f6f8fa;
background-color: #82071e;
}
pre.rouge .c, pre.rouge .ch, pre.rouge .cd, pre.rouge .cm, pre.rouge .cp, pre.rouge .cpf, pre.rouge .c1, pre.rouge .cs {
color: #6e7781;
}
pre.rouge .gl {
color: #6e7781;
}
pre.rouge .gt {
color: #6e7781;
}
pre.rouge .ni {
color: #24292f;
}
pre.rouge .si {
color: #24292f;
}
pre.rouge .ge {
color: #24292f;
font-style: italic;
}
pre.rouge .gs {
color: #24292f;
font-weight: bold;
}
</style>
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>ALOM - TP 11 - EDA !</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_présentation_et_objectifs">1. Présentation et objectifs</a></li>
<li><a href="#_pré_requis">2. Pré-requis</a></li>
<li><a href="#_mailing_api">3. <code>mailing-api</code></a>
<ul class="sectlevel2">
<li><a href="#_démarrage_dune_instance_locale_de_pulsar">3.1. Démarrage d&#8217;une instance locale de pulsar</a></li>
<li><a href="#_configuration_spring_boot">3.2. Configuration Spring Boot</a></li>
<li><a href="#_ajout_dun_listener">3.3. Ajout d&#8217;un listener</a></li>
</ul>
</li>
<li><a href="#_trainer_api">4. <code>trainer-api</code></a>
<ul class="sectlevel2">
<li><a href="#_configuration">4.1. Configuration</a></li>
<li><a href="#_ajout_dun_producer">4.2. Ajout d&#8217;un producer</a></li>
</ul>
</li>
<li><a href="#_battle_api">5. <code>battle-api</code></a></li>
<li><a href="#_configuration_pour_clever_cloud">6. Configuration pour Clever Cloud</a></li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_présentation_et_objectifs"><a class="anchor" href="#_présentation_et_objectifs"></a><a class="link" href="#_présentation_et_objectifs">1. Présentation et objectifs</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Le but est de continuer le développement de notre architecture "à la microservice".</p>
</div>
<div class="paragraph">
<p>Nous allons utiliser Apache Pulsar, pour implémenter un début d&#8217;architecture EDA entre les micro-services game et mailing.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="images/pokemon-archi.png" alt="pokemon archi">
</div>
<div class="title">Figure 1. Notre architecture !</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_pré_requis"><a class="anchor" href="#_pré_requis"></a><a class="link" href="#_pré_requis">2. Pré-requis</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>En pré-requis à ce TP, il faut avoir implémenté la partie <a href="https://alom-2024.gitlabpages.univ-lille.fr/cours/w09-cloud/09-tp-cloud.html#_envoi_demails" class="external" target="_blank" rel="noopener">6. Envoi d&#8217;emails</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_mailing_api"><a class="anchor" href="#_mailing_api"></a><a class="link" href="#_mailing_api">3. <code>mailing-api</code></a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_démarrage_dune_instance_locale_de_pulsar"><a class="anchor" href="#_démarrage_dune_instance_locale_de_pulsar"></a><a class="link" href="#_démarrage_dune_instance_locale_de_pulsar">3.1. Démarrage d&#8217;une instance locale de pulsar</a></h3>
<div class="paragraph">
<p>Apache Pulsar est disponible sous la forme d&#8217;une image Docker : <a href="https://hub.docker.com/r/apachepulsar/pulsar" class="external" target="_blank" rel="noopener">apachepulsar/pulsar</a>.</p>
</div>
<div class="paragraph">
<p>Démarrez une instance de pulsar sur votre poste avec la commande suivante :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="bash">docker container run <span class="nt">-d</span> <span class="se">\</span>
<span class="nt">--name</span> pulsar <span class="se">\</span>
<span class="nt">-p</span> 6650:6650 <span class="se">\</span>
<span class="nt">-p</span> 6080:8080 <span class="se">\</span>
apachepulsar/pulsar:4.0.1 <span class="se">\</span>
bin/pulsar standalone</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_configuration_spring_boot"><a class="anchor" href="#_configuration_spring_boot"></a><a class="link" href="#_configuration_spring_boot">3.2. Configuration Spring Boot</a></h3>
<div class="paragraph">
<p>Dans votre projet <code>mailing</code>, importez la dépendance <code>spring-boot-starter-pulsar</code> :</p>
</div>
<div class="listingblock">
<div class="title">pom.xml</div>
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="xml"><span class="nt">&lt;dependency&gt;</span>
<span class="nt">&lt;groupId&gt;</span>org.springframework.boot<span class="nt">&lt;/groupId&gt;</span>
<span class="nt">&lt;artifactId&gt;</span>spring-boot-starter-pulsar<span class="nt">&lt;/artifactId&gt;</span>
<span class="nt">&lt;/dependency&gt;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Configurez les properties suivantes dans un fichier <code>application-local.properties</code>, pour utiliser votre instance locale :</p>
</div>
<div class="listingblock">
<div class="title">application-local.properties</div>
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="properties"><span class="py">spring.pulsar.client.service-url</span><span class="p">=</span><span class="s">pulsar://localhost:6650</span>
<span class="py">spring.pulsar.admin.service-url</span><span class="p">=</span><span class="s">http://localhost:6080</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_ajout_dun_listener"><a class="anchor" href="#_ajout_dun_listener"></a><a class="link" href="#_ajout_dun_listener">3.3. Ajout d&#8217;un listener</a></h3>
<div class="paragraph">
<p>Créez une classe ou un record qui représentera votre évènement <code>trainer:new</code>.
Cette classe contient l&#8217;adresse mail du trainer, ainsi que son nom.</p>
</div>
<div class="paragraph">
<p>Annotez cette classe avec l&#8217;annotation <code>@PulsarMessage(schemaType = SchemaType.JSON)</code> pour indiquer à Spring Boot que cet objet devra être sérialisé en JSON.</p>
</div>
<div class="paragraph">
<p>Implémentez une classe <code>NewTrainerEventPulsarAdapter</code>.
L&#8217;annotation <code>@PulsarListener</code> permet de marquer une méthode Java comme devant être appelée lorsqu&#8217;un message est disponible dans un topic Pulsar.
Ajoutez une méthode à cette classe, qui porte l&#8217;annotation, et reçoit en paramètre votre classe d&#8217;évènement :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="java"><span class="nd">@PulsarListener</span><span class="o">(</span><span class="n">topics</span> <span class="o">=</span> <span class="s">"trainer:new"</span><span class="o">,</span> <span class="n">subscriptionType</span> <span class="o">=</span> <span class="nc">SubscriptionType</span><span class="o">.</span><span class="na">Shared</span><span class="o">)</span>
<span class="kt">void</span> <span class="nf">receiveEvent</span><span class="o">(</span><span class="nc">NewTrainerEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// TODO</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Cette méthode écoute sur un topic <code>&lt;votre-nom&gt;:trainer:new</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
On utilise un nommage de topic <code>trainer:new</code> avec votre nom en préfixe, pour éviter les conflits entre les étudiants !
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Le paramètre <code>SubscriptionType.Shared</code> permet de partager la connexion au topic entre plusieurs instances de votre micro-service !</p>
</div>
<div class="paragraph">
<p>Cette méthode pourra appeler la méthode de service existant par ailleurs.</p>
</div>
<div class="paragraph">
<p>Le démarrage de votre application devrait afficher les logs de connexion au topic pulsar :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code>o.a.p.c.impl.ConsumerStatsRecorderImpl : Starting Pulsar consumer status recorder with config: {"topicNames":["persistent://public/default/new-trainer"],"topicsPattern":null,"subscriptionName":"org.springframework.Pulsar.PulsarListenerEndpointContainer#0","subscriptionType":"Shared","subscriptionProperties":null,"subscriptionMode":"Durable","receiverQueueSize":1000,"acknowledgementsGroupTimeMicros":100000,"maxAcknowledgmentGroupSize":1000,"negativeAckRedeliveryDelayMicros":60000000,"maxTotalReceiverQueueSizeAcrossPartitions":50000,"consumerName":null,"ackTimeoutMillis":0,"tickDurationMillis":1000,"priorityLevel":0,"maxPendingChunkedMessage":10,"autoAckOldestChunkedMessageOnQueueFull":false,"expireTimeOfIncompleteChunkedMessageMillis":60000,"cryptoFailureAction":"FAIL","properties":{},"readCompacted":false,"subscriptionInitialPosition":"Latest","patternAutoDiscoveryPeriod":60,"regexSubscriptionMode":"PersistentOnly","deadLetterPolicy":null,"retryEnable":false,"autoUpdatePartitions":true,"autoUpdatePartitionsIntervalSeconds":60,"replicateSubscriptionState":false,"resetIncludeHead":false,"batchIndexAckEnabled":false,"ackReceiptEnabled":false,"poolMessages":false,"startPaused":false,"autoScaledReceiverQueueSizeEnabled":false,"topicConfigurations":[],"maxPendingChuckedMessage":10}
o.a.p.c.impl.ConsumerStatsRecorderImpl : Pulsar client config: {"serviceUrl":"pulsar://localhost:6650","authPluginClassName":null,"authParams":null,"authParamMap":null,"operationTimeoutMs":30000,"lookupTimeoutMs":30000,"statsIntervalSeconds":60,"numIoThreads":22,"numListenerThreads":22,"connectionsPerBroker":1,"connectionMaxIdleSeconds":25,"useTcpNoDelay":true,"useTls":false,"tlsKeyFilePath":null,"tlsCertificateFilePath":null,"tlsTrustCertsFilePath":null,"tlsAllowInsecureConnection":false,"tlsHostnameVerificationEnable":false,"concurrentLookupRequest":5000,"maxLookupRequest":50000,"maxLookupRedirects":20,"maxNumberOfRejectedRequestPerConnection":50,"keepAliveIntervalSeconds":30,"connectionTimeoutMs":10000,"requestTimeoutMs":60000,"readTimeoutMs":60000,"autoCertRefreshSeconds":300,"initialBackoffIntervalNanos":100000000,"maxBackoffIntervalNanos":60000000000,"enableBusyWait":false,"listenerName":null,"useKeyStoreTls":false,"sslProvider":null,"tlsKeyStoreType":"JKS","tlsKeyStorePath":null,"tlsKeyStorePassword":null,"tlsTrustStoreType":"JKS","tlsTrustStorePath":null,"tlsTrustStorePassword":null,"tlsCiphers":[],"tlsProtocols":[],"memoryLimitBytes":67108864,"proxyServiceUrl":null,"proxyProtocol":null,"enableTransaction":false,"dnsLookupBindAddress":null,"dnsLookupBindPort":0,"dnsServerAddresses":[],"socks5ProxyAddress":null,"socks5ProxyUsername":null,"socks5ProxyPassword":null,"description":null,"openTelemetry":null}
o.a.pulsar.client.impl.ConsumerImpl : [persistent://public/default/trainer:new][org.springframework.Pulsar.PulsarListenerEndpointContainer#0] Subscribing to topic on cnx [id: 0x58864231, L:/127.0.0.1:38618 - R:localhost/127.0.0.1:6650], consumerId 0
o.a.pulsar.client.impl.ConsumerImpl : [persistent://public/default/trainer:new][org.springframework.Pulsar.PulsarListenerEndpointContainer#0] Subscribed to topic on localhost/127.0.0.1:6650 -- consumer: 0</code></pre>
</div>
</div>
<div class="paragraph">
<p>Implémentez toutes les méthodes disponibles sur le mailing service avec des listener Pulsar :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>envoi d&#8217;un email de bienvenue (reçoit le nom d’un Trainer en paramètre, ainsi que son email)</p>
</li>
<li>
<p>envoi d&#8217;un email de fin de combat (reçoit les noms des 2 adversaires, leurs emails, et l’information de qui a gagné le combat)</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_trainer_api"><a class="anchor" href="#_trainer_api"></a><a class="link" href="#_trainer_api">4. <code>trainer-api</code></a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_configuration"><a class="anchor" href="#_configuration"></a><a class="link" href="#_configuration">4.1. Configuration</a></h3>
<div class="paragraph">
<p>Ajoutez la dépendance <code>spring-boot-starter-pulsar</code> à votre projet <code>trainer-ui</code>.</p>
</div>
<div class="paragraph">
<p>Configurez les properties suivantes dans un fichier <code>application-local.properties</code>, pour utiliser votre instance locale :</p>
</div>
<div class="listingblock">
<div class="title">application-local.properties</div>
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="properties"><span class="py">spring.pulsar.client.service-url</span><span class="p">=</span><span class="s">pulsar://localhost:6650</span>
<span class="py">spring.pulsar.admin.service-url</span><span class="p">=</span><span class="s">http://localhost:6080</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_ajout_dun_producer"><a class="anchor" href="#_ajout_dun_producer"></a><a class="link" href="#_ajout_dun_producer">4.2. Ajout d&#8217;un producer</a></h3>
<div class="paragraph">
<p>Spring propose un <code>PulsarTemplate</code> pour poster des messages dans un topic.
Dans une classe de <code>game-ui</code>, nommée <code>UserEventsPulsarAdapter</code>, utilisez le <code>PulsarTemplate</code> (reçu en injection de dépendance) pour envoyer les évènements à destination du <code>mailing-api</code> dans le topic consacré <code>&lt;votre-nom&gt;:trainer:new</code>.</p>
</div>
<div class="paragraph">
<p>À titre d&#8217;exemple, voici un usage du <code>PulsarTemplate</code> pour envoyer un message sur un topic :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="java"><span class="n">pulsarTemplate</span><span class="o">.</span><span class="na">send</span><span class="o">(</span>
<span class="s">"trainer:new"</span><span class="o">,</span>
<span class="k">new</span> <span class="nf">NewTrainerEvent</span><span class="o">(</span><span class="s">"Ash"</span><span class="o">,</span> <span class="s">"ash@gitlab-classrooms.org"</span><span class="o">)</span>
<span class="o">);</span></code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
N&#8217;hésitez pas à copier/coller votre classe correspondant à l&#8217;évènement attendu depuis <code>mailing-api</code>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Isolez toutes ces classes dans un package consacré. Vous pouvez aussi exposer une interface <code>UserEventsPort</code> dans votre couche "domaine" si elle existe, pour reprendre les principes de l&#8217;architecture hexagonale.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_battle_api"><a class="anchor" href="#_battle_api"></a><a class="link" href="#_battle_api">5. <code>battle-api</code></a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Dans <code>battle-api</code>, implémentez l&#8217;envoi d&#8217;un message lors de la fin d&#8217;un combat, à destination du <code>mailing-api</code> dans le topic consacré <code>&lt;votre-nom&gt;:battle:end</code>, de la même manière que cela a été fait entre <code>game-ui</code> et <code>mailing-api</code>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration_pour_clever_cloud"><a class="anchor" href="#_configuration_pour_clever_cloud"></a><a class="link" href="#_configuration_pour_clever_cloud">6. Configuration pour Clever Cloud</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>La configuration de l&#8217;utilisation de Pulsar sur Clever Cloud nécessite quelques ajustements :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>l&#8217;instance de Pulsar est partagée entre tous les étudiants</p>
</li>
<li>
<p>la connexion à Pulsar nécessite une authentification</p>
</li>
<li>
<p>les topics peuvent être créés dans un tenant/namespace unique</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Toutes les informations nécessaires à la connexion à Pulsar sont disponibles à 2 endroits :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>dans la console <a href="https://console.clever-cloud.com/organisations/orga_d02d9099-9664-47fd-8029-d90e36628e1d/addons/addon_baad03f5-7cbd-4d52-9b86-df292644b955/services-dependencies" class="external" target="_blank" rel="noopener">Clever Cloud</a>.</p>
</li>
<li>
<p>dans un secret sur <a href="https://vault-alom-2024.cleverapps.io/ui/vault/secrets/secret/kv/list" class="external" target="_blank" rel="noopener">Vault</a>.</p>
</li>
</ul>
</div>
<div class="imageblock">
<div class="content">
<img src="images/clever-pulsar.png" alt="clever pulsar">
</div>
<div class="title">Figure 2. Les secrets Pulsar dans Clever Cloud</div>
</div>
<div class="imageblock">
<div class="content">
<img src="images/vault-pulsar.png" alt="vault pulsar">
</div>
<div class="title">Figure 3. Les secrets Pulsar dans Vault</div>
</div>
<div class="paragraph">
<p>Configurez dans vos projets <code>mailing-api</code>, <code>game-ui</code> et <code>battle-api</code> l&#8217;utilisation de l&#8217;instance Pulsar de Clever Cloud :</p>
</div>
<div class="listingblock">
<div class="title">application-clever.properties</div>
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="properties"><span class="py">spring.pulsar.client.service-url</span><span class="p">=</span> <i class="conum" data-value="1"></i><b>(1)</b>
<span class="s">spring.pulsar.client.authentication.plugin-class-name=org.apache.pulsar.client.impl.auth.AuthenticationToken</span>
<span class="py">spring.pulsar.client.authentication.param.token</span><span class="p">=</span> <i class="conum" data-value="2"></i><b>(2)</b>
<span class="s">spring.pulsar.admin.service-url= </span><i class="conum" data-value="3"></i><b>(3)</b>
<span class="py">spring.pulsar.admin.authentication.plugin-class-name</span><span class="p">=</span><span class="s">org.apache.pulsar.client.impl.auth.AuthenticationToken</span>
<span class="py">spring.pulsar.admin.authentication.param.token</span><span class="p">=</span> <i class="conum" data-value="2"></i><b>(2)</b>
<span class="s">spring.pulsar.defaults.topic.tenant= </span><i class="conum" data-value="4"></i><b>(4)</b>
<span class="py">spring.pulsar.defaults.topic.namespace</span><span class="p">=</span> <i class="conum" data-value="5"></i><b>(5)</b></code></pre>
</div>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Utilisez la valeur de <code>ADDON_PULSAR_BINARY_URL</code></p>
</li>
<li>
<p>Utilisez la valeur de <code>ADDON_PULSAR_TOKEN</code></p>
</li>
<li>
<p>Utilisez la valeur de <code>ADDON_PULSAR_HTTP_URL</code></p>
</li>
<li>
<p>Utilisez la valeur de <code>ADDON_PULSAR_TENANT</code></p>
</li>
<li>
<p>Utilisez la valeur de <code>ADDON_PULSAR_NAMESPACE</code></p>
</li>
</ol>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-03 15:35:59 +0100
</div>
</div>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
messageStyle: "none",
tex2jax: {
inlineMath: [["\\(", "\\)"]],
displayMath: [["\\[", "\\]"]],
ignoreClass: "nostem|nolatexmath"
},
asciimath2jax: {
delimiters: [["\\$", "\\$"]],
ignoreClass: "nostem|noasciimath"
},
TeX: { equationNumbers: { autoNumber: "none" } }
})
MathJax.Hub.Register.StartupHook("AsciiMath Jax Ready", function () {
MathJax.InputJax.AsciiMath.postfilterHooks.Add(function (data, node) {
if ((node = data.script.parentNode) && (node = node.parentNode) && node.classList.contains("stemblock")) {
data.math.root.display = "block"
}
return data
})
})
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-MML-AM_HTMLorMML"></script>
</body>
</html>
\ No newline at end of file
File added
w11-eda/images/clever-pulsar.png

34.1 KiB

w11-eda/images/pokemon-archi.png

57.3 KiB

w11-eda/images/vault-pulsar.png

38.2 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment