MicroK8s: tři roky zkušeností s Kubernetes v Ubuntu

9. 10. 2024
Doba čtení: 6 minut

Sdílet

Autor: Depositphotos
V článcích na internetu často narazíte jen na krátkodobé zkušenosti. Proto jsem se rozhodl podělit o svou tříletou zkušenost s Kubernetes řešením MicroK8s od Canonicalu, abyste věděli, co očekávat a na co si dát pozor.

Když si na internetu pročítáte recenze u výrobků či recenze od redaktorů nějakého časopisu, často narazíte na to, že daný redaktor či recenzent má zkušenost v řádu dnů či týdnů, a to není úplně vypovídající. Proto jsem se rozhodl napsat recenzi Kubernetes řešení MicroK8s od Canonicalu po třech letech používání, abyste věděli, co vás čeká, kde jsem udělal chyby, i kde se můžete snadno spálit.

Pro koho je MicroK8s

Předně, MicroK8s je řešení pro malé vývojové týmy a lokální instalace Kubernetes, které potřebujete rychle lokálně zprovoznit. Může se jednat i o produkční řešení, nicméně opravdu nějaký velký projekt bych na tom asi neprovozoval.

Jako příklad uživatelů se berou menší vývojářská studia, nebo třeba nějaké lokální řešení urychlovače v CERN. Alespoň tím se Canonical chlubí, jako případovou studií.

Prvotní instalace

Prvotní instalace MicroK8s je snadná, když víte jak na to a přečtete si manuál, pokud jste v Kubernetes úplný nováček, a jdete metodou pokus omyl, snadno se spálíte – ovšem to bych asi nebral jako chybu Canonicalu.

MicroK8s nainstalujete jako jednoduchý balíček „snap“ do svého Ubuntu, a chtěl jsem napsat, že můžete hned fungovat, ale není to tak. Samozřejmě potřebujete zprovoznit nějaké diskové úložiště – Persistent Volume, buďto v rámci NFS nebo třeba lokálního disku. Také potřebujete zprovoznit ingress, což je vlastně taková reverzní proxy, a taky Helm, což je zase balíčkovací manažer pro Kubernetes.

Zde nastala moje prvotní chyba, když jsem začínal, vše jsem se snažil nějak doinstalovat sám. U MicroK8s si tak zbytečně přiděláváte práci a „bojujete s větrnými mlýny“. Vše je totiž dostupné jako přídavný balíček, tzv. „add-on“, který můžete doinstalovat jedním příkazem, například  microk8s enable ingress.

Doporučuji si na webu projít seznam všech přídavných modulů, ať zbytečně znovu neobjevujete kolo. Pokud půjdete jejich přímou instalací, myslím že Kubernetes rozběhnete v klidu do hodiny.

Výhody MicroK8s

Výhodou MicroK8s je dostupný dashboard, kterým můžete Kubernetes spravovat přes web. Další výhodou je velmi snadná aktualizace přes balíček snap a relativně spolehlivý provoz – nějaké větší problémy jsem nezaznamenal. Dokonce je to i distribuce, kterou snadno rozběhnete na Raspberry Pi.

Dashboard v MicroK8s

Zkoušíme si vlastní instalaci

Instalace Grafany nabízí jednoduchou možnost, jak si vše vyzkoušet. Nejprve nainstalujeme MicroK8s na Ubuntu pomocí balíčku snap.

$ sudo snap install microk8s --classic

Poté přidáme aktuálního uživatele do seznamu uživatelů MicroK8s.

$ sudo usermod -aG microk8s $USER
$ sudo chown -f -R $USER ~/.kube

Nakonec aktivujeme nezbytné moduly.

$ microk8s enable dns
$ microk8s enable ingress
$ microk8s enable helm3
$ microk8s enable storage

Zde se zastavím u krátkého vysvětlení. Předně je třeba říct, že Kubernetes spouští jednotlivé kontejnery bez přístupu ke klasickému DNS resolveru, který máte nainstalovaný v operačním systému. Tedy pokud neaktivujete DNS v clusteru, nedostanete se na internet. Standardně se tedy v clusteru spustí tzv. služba Core DNS, která má vlastní upstream server a přeposílá veškeré požadavky na server zmíněný v  /etc/resolv.conf.

Další věcí, kterou aktivujeme je ingress. Standardně Kubernetes používá služby, to je každý pod (skupina kontejnerů využívající stejný síťový jmenný prostor) se připojuje ke službě, na kterou je možné posílat požadavky na port, třeba 8080 TCP. To by ovšem většině uživatelů nestačilo, protože na jedné doméně provozují více služeb a jednu doménu zpravidla obsluhuje více kontejnerů. Proto je třeba rozdělit provoz mezi kontejnery pomocí doménového jména, nebo cesty v doménovém jméně pomocí reverzní proxy. V názvosloví Kubernetes se právě tomuhle říká ingress.

Třetí věcí, kterou aktivujeme je Helm. To je vlastně balíčkovací systém určený pro Kubernetes. Ten nám umožňuje snadno instalovat nějaký produkt, který si sám řeší ingress, služby, úložiště a kontejnery s konfigurací v jednom souboru.

Poslední věcí, kterou si doinstalujeme je balíček storage. Ten by nám měl vytvořit výchozí storage class, což je vlastně třída úložiště, u které si žádáme o diskový prostor. Funguje to poměrně jednoduše, vy si pomocí Persistent Volume Claim (PVC) zažádáte například o úložiště 10GB nějakou třídu úložiště (standardně tu výchozí, ale může jich být víc, třeba nějaká v NFS, nebo AWS EBS apod.), a ta vám dané úložiště poskytne. Tyto definice PVC jsou například součástí balíčku Helm.

Nyní si stáhneme balíček Helm.

$ helm repo add grafana https://grafana.github.io/helm-charts
$ helm repo update

Nakonec ho rozbalíme a vyextrahujeme soubor Values.yml.

$ helm pull grafana/grafana –untar

Až stáhneme balíček a vyextrahujeme, měli bychom narazit na soubor Values.yml. V tom tradičně nejvíce upravujeme položky „ingress“ a „storageclass“ podle svého nastavení, případně třeba také výchozí hesla.

Balíček nainstalujeme.

$ helm install grafana ./grafana --values ./grafana/values.yaml

Ke Grafaně přistoupíme na port 80. Pokud jsme aktivovali ingress, tak na portu 80 operačního systému bychom měli vidět rozhraní Grafany, samozřejmě jen v případě, že máme správně nastaven ingress. Případně si přidejte doménu do /etc/hosts a nastavte si ji na ingressu.

Běžící Grafana

Na jaké problémy jsem narazil

Prvním problémem, s kterým dodnes bojuji je záloha databáze etcd. S aktualizací MicroK8s na novější verzi se to rozbilo, je na to vytvořen bug report a mnoho uživatelů chybu potvrzuje. Bohužel se měsíce  nic dalšího neděje, což by mě trošku odrazovalo od nasazení takového nástroje v produkčním prostředí. Ale principiálně, pokud máte způsob zálohy jiný (třeba zálohujete celý virtuál), nemusí to vlastně tolik vadit.

Dalším problémem, na který přijdete po delším čase, je zabírání místa na disku nepoužívanými obrazy kontejnerů. Existuje sice neoficiální nástroj „microk8s prune“, ale Canonical na to hned v počátku vůbec nemyslí, a tak pokud jste na štíru s místem na disku, můžete rychle narazit. Zmíněný nástroj vám místo pročistí, můžete si ho dát třeba do cronu.

Posledním problémem, který spatřuji je, že se jedná o aplikaci v Ubuntu. Musíte tedy čas od času aktualizovat hostitelský systém mezi verzemi, což se nemusí obejít bez komplikací. Například při aktualizaci z verze Ubuntu 24.04 na verzi 24.04.1 se mi rozbil Nginx, kde se vývojáři rozhodli rozdělit jeho zásuvné moduly do samostatného balíčku, který se s aktualizací sám nenainstaloval.

Ještě abych nezapomněl, MicroK8s má jednu takovou zvláštnost. Normálně se řeší síťování v Kubernetes pomocí plug-inu CNI – Container Network Interface, který upravuje pravidla v IPtables. V novějších distribucích je vedle IPtables k dispozici také modernější firewall Nft. MicroK8s bohužel používá starší IPtables pomocí nástrojů iptables-legacy.

Skvělý pro začátečníky

Myslím si, že MicroK8s je skvělá distribuce Kubernetes pro začátečníky, interní vývoj a domácí produkci. Do komerční produkce se podle mě jedná o produkt nevhodný, ani sám výrobce jej tam necílí.

Pokud si po instalaci projdete dokumentaci, a základní funkcionalitu doinstalujete pomocí zásuvných modulů, nebudete se ani moc trápit. Pokud půjdete metodou pokusů a omylů, můžete se natrápit značně víc.

hacking_tip

Osobně mi několik let non-stop běží v pohodě server, kde mám desítky služeb – zásadnější problémy jsem nezpozoroval. Co bych udělal jinak, kdybych začínal od začátku? Opravdu bych si nejdřív do detailu přečetl celou dokumentaci, která není zase tak dlouhá.

(Autorem obrázků je Martin Koníček.)

Autor článku

V oboru informačních technologií se pohybuje přes 20 let. V současné době pracuje jako kontraktor pro DevOps.

'; document.getElementById('preroll-iframe').onload = function () { setupIframe(); } prerollContainer = document.getElementsByClassName('preroll-container-iframe')[0]; } function setupIframe() { prerollDocument = document.getElementById('preroll-iframe').contentWindow.document; let el = prerollDocument.createElement('style'); prerollDocument.head.appendChild(el); el.innerText = "#adContainer>div:nth-of-type(1),#adContainer>div:nth-of-type(1) > iframe { width: 99% !important;height: 99% !important;max-width: 100%;}#videoContent,body{ width:100vw;height:100vh}body{ font-family:'Helvetica Neue',Arial,sans-serif}#videoContent{ overflow:hidden;background:#000}#adMuteBtn{ width:35px;height:35px;border:0;background:0 0;display:none;position:absolute;fill:rgba(230,230,230,1);bottom:20px;right:25px}"; videoContent = prerollDocument.getElementById('contentElement'); videoContent.style.display = 'none'; videoContent.volume = 1; videoContent.muted = false; const playPromise = videoContent.play(); if (playPromise !== undefined) { playPromise.then(function () { console.log('PREROLL sound allowed'); // setUpIMA(true); videoContent.volume = 1; videoContent.muted = false; setUpIMA(); }).catch(function () { console.log('PREROLL sound forbidden'); videoContent.volume = 0; videoContent.muted = true; setUpIMA(); }); } } function setupDimensions() { prerollWidth = Math.min(iinfoPrerollPosition.offsetWidth, 480); prerollHeight = Math.min(iinfoPrerollPosition.offsetHeight, 320); } function setUpIMA() { google.ima.settings.setDisableCustomPlaybackForIOS10Plus(true); google.ima.settings.setLocale('cs'); google.ima.settings.setNumRedirects(10); // Create the ad display container. createAdDisplayContainer(); // Create ads loader. adsLoader = new google.ima.AdsLoader(adDisplayContainer); // Listen and respond to ads loaded and error events. adsLoader.addEventListener( google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED, onAdsManagerLoaded, false); adsLoader.addEventListener( google.ima.AdErrorEvent.Type.AD_ERROR, onAdError, false); // An event listener to tell the SDK that our content video // is completed so the SDK can play any post-roll ads. const contentEndedListener = function () { adsLoader.contentComplete(); }; videoContent.onended = contentEndedListener; // Request video ads. const adsRequest = new google.ima.AdsRequest(); adsRequest.adTagUrl = iinfoVastUrls[iinfoVastUrlIndex]; console.log('Preroll advert: ' + iinfoVastUrls[iinfoVastUrlIndex]); videoContent.muted = false; videoContent.volume = 1; // Specify the linear and nonlinear slot sizes. This helps the SDK to // select the correct creative if multiple are returned. // adsRequest.linearAdSlotWidth = prerollWidth; // adsRequest.linearAdSlotHeight = prerollHeight; adsRequest.nonLinearAdSlotWidth = 0; adsRequest.nonLinearAdSlotHeight = 0; adsLoader.requestAds(adsRequest); } function createAdDisplayContainer() { // We assume the adContainer is the DOM id of the element that will house // the ads. prerollDocument.getElementById('videoContent').style.display = 'none'; adDisplayContainer = new google.ima.AdDisplayContainer( prerollDocument.getElementById('adContainer'), videoContent); } function unmutePrerollAdvert() { adVolume = !adVolume; if (adVolume) { adsManager.setVolume(0.3); prerollDocument.getElementById('adMuteBtn').innerHTML = ''; } else { adsManager.setVolume(0); prerollDocument.getElementById('adMuteBtn').innerHTML = ''; } } function onAdsManagerLoaded(adsManagerLoadedEvent) { // Get the ads manager. const adsRenderingSettings = new google.ima.AdsRenderingSettings(); adsRenderingSettings.restoreCustomPlaybackStateOnAdBreakComplete = true; adsRenderingSettings.loadVideoTimeout = 12000; // videoContent should be set to the content video element. adsManager = adsManagerLoadedEvent.getAdsManager(videoContent, adsRenderingSettings); // Add listeners to the required events. adsManager.addEventListener(google.ima.AdErrorEvent.Type.AD_ERROR, onAdError); adsManager.addEventListener( google.ima.AdEvent.Type.CONTENT_PAUSE_REQUESTED, onContentPauseRequested); adsManager.addEventListener( google.ima.AdEvent.Type.CONTENT_RESUME_REQUESTED, onContentResumeRequested); adsManager.addEventListener( google.ima.AdEvent.Type.ALL_ADS_COMPLETED, onAdEvent); // Listen to any additional events, if necessary. adsManager.addEventListener(google.ima.AdEvent.Type.LOADED, onAdEvent); adsManager.addEventListener(google.ima.AdEvent.Type.STARTED, onAdEvent); adsManager.addEventListener(google.ima.AdEvent.Type.COMPLETE, onAdEvent); playAds(); } function playAds() { // Initialize the container. Must be done through a user action on mobile // devices. videoContent.load(); adDisplayContainer.initialize(); // setupDimensions(); try { // Initialize the ads manager. Ad rules playlist will start at this time. adsManager.init(1920, 1080, google.ima.ViewMode.NORMAL); // Call play to start showing the ad. Single video and overlay ads will // start at this time; the call will be ignored for ad rules. adsManager.start(); // window.addEventListener('resize', function (event) { // if (adsManager) { // setupDimensions(); // adsManager.resize(prerollWidth, prerollHeight, google.ima.ViewMode.NORMAL); // } // }); } catch (adError) { // An error may be thrown if there was a problem with the VAST response. // videoContent.play(); } } function onAdEvent(adEvent) { const ad = adEvent.getAd(); console.log('Preroll event: ' + adEvent.type); switch (adEvent.type) { case google.ima.AdEvent.Type.LOADED: if (!ad.isLinear()) { videoContent.play(); } prerollDocument.getElementById('adContainer').style.width = '100%'; prerollDocument.getElementById('adContainer').style.maxWidth = '640px'; prerollDocument.getElementById('adContainer').style.height = '360px'; break; case google.ima.AdEvent.Type.STARTED: window.addEventListener('scroll', onActiveView); if (ad.isLinear()) { intervalTimer = setInterval( function () { // Example: const remainingTime = adsManager.getRemainingTime(); // adsManager.pause(); }, 300); // every 300ms } prerollDocument.getElementById('adMuteBtn').style.display = 'block'; break; case google.ima.AdEvent.Type.ALL_ADS_COMPLETED: if (ad.isLinear()) { clearInterval(intervalTimer); } if (prerollLastError === 303) { playYtVideo(); } break; case google.ima.AdEvent.Type.COMPLETE: if (ad.isLinear()) { clearInterval(intervalTimer); } playYtVideo(); break; } } function onAdError(adErrorEvent) { console.log(adErrorEvent.getError()); prerollLastError = adErrorEvent.getError().getErrorCode(); if (!loadNext()) { playYtVideo(); } } function loadNext() { iinfoVastUrlIndex++; if (iinfoVastUrlIndex < iinfoVastUrls.length) { iinfoPrerollPosition.remove(); playPrerollAd(); } else { return false; } adVolume = 1; return true; } function onContentPauseRequested() { videoContent.pause(); } function onContentResumeRequested() { videoContent.play(); } function onActiveView() { if (prerollContainer) { const containerOffset = prerollContainer.getBoundingClientRect(); const windowHeight = window.innerHeight; if (containerOffset.top < windowHeight/1 && containerOffset.bottom > 0.0) { if (prerollPaused) { adsManager.resume(); prerollPaused = false; } return true; } else { if (!prerollPaused) { adsManager.pause(); prerollPaused = true; } } } return false; } function playYtVideo() { iinfoPrerollPosition.remove(); youtubeIframe.style.display = 'block'; youtubeIframe.src += '&autoplay=1&mute=1'; } }
'; document.getElementById('outstream-iframe').onload = function () { setupIframe(); } replayScreen = document.getElementById('iinfoOutstreamReplay'); iinfoOutstreamPosition = document.getElementById('iinfoOutstreamPosition'); outstreamContainer = document.getElementsByClassName('outstream-container')[0]; setupReplayScreen(); } function setupIframe() { outstreamDocument = document.getElementById('outstream-iframe').contentWindow.document; let el = outstreamDocument.createElement('style'); outstreamDocument.head.appendChild(el); el.innerText = "#adContainer>div:nth-of-type(1),#adContainer>div:nth-of-type(1) > iframe { width: 99% !important;height: 99% !important;max-width: 100%;}#videoContent,body{ width:100vw;height:100vh}body{ font-family:'Helvetica Neue',Arial,sans-serif}#videoContent{ overflow:hidden;background:#000}#adMuteBtn{ width:35px;height:35px;border:0;background:0 0;display:none;position:absolute;fill:rgba(230,230,230,1);bottom:-5px;right:25px}"; videoContent = outstreamDocument.getElementById('contentElement'); videoContent.style.display = 'none'; videoContent.volume = 1; videoContent.muted = false; if ( location.href.indexOf('rejstriky.finance.cz') !== -1 || location.href.indexOf('finance-rejstrik') !== -1 || location.href.indexOf('firmy.euro.cz') !== -1 || location.href.indexOf('euro-rejstrik') !== -1 || location.href.indexOf('/rejstrik/') !== -1 || location.href.indexOf('/rejstrik-firem/') !== -1) { outstreamDirectPlayed = true; soundAllowed = true; iinfoVastUrlIndex = 0; } if (!outstreamDirectPlayed) { console.log('OUTSTREAM direct'); setUpIMA(true); } else { if (soundAllowed) { const playPromise = videoContent.play(); if (playPromise !== undefined) { playPromise.then(function () { console.log('OUTSTREAM sound allowed'); setUpIMA(false); }).catch(function () { console.log('OUTSTREAM sound forbidden'); renderBanner(); }); } } else { renderBanner(); } } } function getWrapper() { let articleWrapper = document.querySelector('.rs-outstream-placeholder'); // Outstream Placeholder from RedSys manipulation if (articleWrapper && articleWrapper.style.display !== 'block') { articleWrapper.innerHTML = ""; articleWrapper.style.display = 'block'; } // Don't render OutStream on homepages if (articleWrapper === null) { if (document.querySelector('body.p-index')) { return null; } } if (articleWrapper === null) { articleWrapper = document.getElementById('iinfo-outstream'); } if (articleWrapper === null) { articleWrapper = document.querySelector('.layout-main__content .detail__article p:nth-of-type(6)'); } if (articleWrapper === null) { // Euro, Autobible, Zdravi articleWrapper = document.querySelector('.o-article .o-article__text p:nth-of-type(6)'); } if (articleWrapper === null) { articleWrapper = document.getElementById('sidebar'); } if (!articleWrapper) { console.error("Outstream wrapper of article was not found."); } return articleWrapper; } function setupDimensions() { outstreamWidth = Math.min(iinfoOutstreamPosition.offsetWidth, 480); outstreamHeight = Math.min(iinfoOutstreamPosition.offsetHeight, 320); } /** * Sets up IMA ad display container, ads loader, and makes an ad request. */ function setUpIMA(direct) { google.ima.settings.setDisableCustomPlaybackForIOS10Plus(true); google.ima.settings.setLocale('cs'); google.ima.settings.setNumRedirects(10); // Create the ad display container. createAdDisplayContainer(); // Create ads loader. adsLoader = new google.ima.AdsLoader(adDisplayContainer); // Listen and respond to ads loaded and error events. adsLoader.addEventListener( google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED, onAdsManagerLoaded, false); adsLoader.addEventListener( google.ima.AdErrorEvent.Type.AD_ERROR, onAdError, false); // An event listener to tell the SDK that our content video // is completed so the SDK can play any post-roll ads. const contentEndedListener = function () { adsLoader.contentComplete(); }; videoContent.onended = contentEndedListener; // Request video ads. const adsRequest = new google.ima.AdsRequest(); if (direct) { adsRequest.adTagUrl = directVast; console.log('Outstream DIRECT CAMPAING advert: ' + directVast); videoContent.muted = true; videoContent.volume = 0; outstreamDirectPlayed = true; } else { adsRequest.adTagUrl = iinfoVastUrls[iinfoVastUrlIndex]; console.log('Outstream advert: ' + iinfoVastUrls[iinfoVastUrlIndex]); videoContent.muted = false; videoContent.volume = 1; } // Specify the linear and nonlinear slot sizes. This helps the SDK to // select the correct creative if multiple are returned. // adsRequest.linearAdSlotWidth = outstreamWidth; // adsRequest.linearAdSlotHeight = outstreamHeight; adsRequest.nonLinearAdSlotWidth = 0; adsRequest.nonLinearAdSlotHeight = 0; adsLoader.requestAds(adsRequest); } function setupReplayScreen() { replayScreen.addEventListener('click', function () { iinfoOutstreamPosition.remove(); iinfoVastUrlIndex = 0; outstreamInit(); }); } /** * Sets the 'adContainer' div as the IMA ad display container. */ function createAdDisplayContainer() { // We assume the adContainer is the DOM id of the element that will house // the ads. outstreamDocument.getElementById('videoContent').style.display = 'none'; adDisplayContainer = new google.ima.AdDisplayContainer( outstreamDocument.getElementById('adContainer'), videoContent); } function unmuteAdvert() { adVolume = !adVolume; if (adVolume) { adsManager.setVolume(0.3); outstreamDocument.getElementById('adMuteBtn').innerHTML = ''; } else { adsManager.setVolume(0); outstreamDocument.getElementById('adMuteBtn').innerHTML = ''; } } /** * Loads the video content and initializes IMA ad playback. */ function playAds() { // Initialize the container. Must be done through a user action on mobile // devices. videoContent.load(); adDisplayContainer.initialize(); // setupDimensions(); try { // Initialize the ads manager. Ad rules playlist will start at this time. adsManager.init(1920, 1080, google.ima.ViewMode.NORMAL); // Call play to start showing the ad. Single video and overlay ads will // start at this time; the call will be ignored for ad rules. adsManager.start(); // window.addEventListener('resize', function (event) { // if (adsManager) { // setupDimensions(); // adsManager.resize(outstreamWidth, outstreamHeight, google.ima.ViewMode.NORMAL); // } // }); } catch (adError) { // An error may be thrown if there was a problem with the VAST response. // videoContent.play(); } } /** * Handles the ad manager loading and sets ad event listeners. * @param { !google.ima.AdsManagerLoadedEvent } adsManagerLoadedEvent */ function onAdsManagerLoaded(adsManagerLoadedEvent) { // Get the ads manager. const adsRenderingSettings = new google.ima.AdsRenderingSettings(); adsRenderingSettings.restoreCustomPlaybackStateOnAdBreakComplete = true; adsRenderingSettings.loadVideoTimeout = 12000; // videoContent should be set to the content video element. adsManager = adsManagerLoadedEvent.getAdsManager(videoContent, adsRenderingSettings); // Add listeners to the required events. adsManager.addEventListener(google.ima.AdErrorEvent.Type.AD_ERROR, onAdError); adsManager.addEventListener( google.ima.AdEvent.Type.CONTENT_PAUSE_REQUESTED, onContentPauseRequested); adsManager.addEventListener( google.ima.AdEvent.Type.CONTENT_RESUME_REQUESTED, onContentResumeRequested); adsManager.addEventListener( google.ima.AdEvent.Type.ALL_ADS_COMPLETED, onAdEvent); // Listen to any additional events, if necessary. adsManager.addEventListener(google.ima.AdEvent.Type.LOADED, onAdEvent); adsManager.addEventListener(google.ima.AdEvent.Type.STARTED, onAdEvent); adsManager.addEventListener(google.ima.AdEvent.Type.COMPLETE, onAdEvent); playAds(); } /** * Handles actions taken in response to ad events. * @param { !google.ima.AdEvent } adEvent */ function onAdEvent(adEvent) { // Retrieve the ad from the event. Some events (for example, // ALL_ADS_COMPLETED) don't have ad object associated. const ad = adEvent.getAd(); console.log('Outstream event: ' + adEvent.type); switch (adEvent.type) { case google.ima.AdEvent.Type.LOADED: // This is the first event sent for an ad - it is possible to // determine whether the ad is a video ad or an overlay. if (!ad.isLinear()) { // Position AdDisplayContainer correctly for overlay. // Use ad.width and ad.height. videoContent.play(); } outstreamDocument.getElementById('adContainer').style.width = '100%'; outstreamDocument.getElementById('adContainer').style.maxWidth = '640px'; outstreamDocument.getElementById('adContainer').style.height = '360px'; break; case google.ima.AdEvent.Type.STARTED: window.addEventListener('scroll', onActiveView); // This event indicates the ad has started - the video player // can adjust the UI, for example display a pause button and // remaining time. if (ad.isLinear()) { // For a linear ad, a timer can be started to poll for // the remaining time. intervalTimer = setInterval( function () { // Example: const remainingTime = adsManager.getRemainingTime(); // adsManager.pause(); }, 300); // every 300ms } outstreamDocument.getElementById('adMuteBtn').style.display = 'block'; break; case google.ima.AdEvent.Type.ALL_ADS_COMPLETED: if (ad.isLinear()) { clearInterval(intervalTimer); } if (outstreamLastError === 303) { if (isBanner) { renderBanner(); } else { replayScreen.style.display = 'flex'; } } break; case google.ima.AdEvent.Type.COMPLETE: // This event indicates the ad has finished - the video player // can perform appropriate UI actions, such as removing the timer for // remaining time detection. if (ad.isLinear()) { clearInterval(intervalTimer); } if (isBanner) { renderBanner(); } else { replayScreen.style.display = 'flex'; } break; } } /** * Handles ad errors. * @param { !google.ima.AdErrorEvent } adErrorEvent */ function onAdError(adErrorEvent) { // Handle the error logging. console.log(adErrorEvent.getError()); outstreamLastError = adErrorEvent.getError().getErrorCode(); if (!loadNext()) { renderBanner(); } } function renderBanner() { if (isBanner) { console.log('Outstream: Render Banner'); iinfoOutstreamPosition.innerHTML = ""; iinfoOutstreamPosition.style.height = "330px"; iinfoOutstreamPosition.appendChild(bannerDiv); } else { console.log('Outstream: Banner is not set'); } } function loadNext() { iinfoVastUrlIndex++; if (iinfoVastUrlIndex < iinfoVastUrls.length) { iinfoOutstreamPosition.remove(); outstreamInit(); } else { return false; } adVolume = 1; return true; } /** * Pauses video content and sets up ad UI. */ function onContentPauseRequested() { videoContent.pause(); // This function is where you should setup UI for showing ads (for example, // display ad timer countdown, disable seeking and more.) // setupUIForAds(); } /** * Resumes video content and removes ad UI. */ function onContentResumeRequested() { videoContent.play(); // This function is where you should ensure that your UI is ready // to play content. It is the responsibility of the Publisher to // implement this function when necessary. // setupUIForContent(); } function onActiveView() { if (outstreamContainer) { const containerOffset = outstreamContainer.getBoundingClientRect(); const windowHeight = window.innerHeight; if (containerOffset.top < windowHeight/1 && containerOffset.bottom > 0.0) { if (outstreamPaused) { adsManager.resume(); outstreamPaused = false; } return true; } else { if (!outstreamPaused) { adsManager.pause(); outstreamPaused = true; } } } return false; } let outstreamInitInterval; if (typeof cpexPackage !== "undefined") { outstreamInitInterval = setInterval(tryToInitializeOutstream, 100); } else { const wrapper = getWrapper(); if (wrapper) { let outstreamInitialized = false; window.addEventListener('scroll', () => { if (!outstreamInitialized) { const containerOffset = wrapper.getBoundingClientRect(); const windowHeight = window.innerHeight; if (containerOffset.top < windowHeight / 1 && containerOffset.bottom > 0.0) { outstreamInit(); outstreamInitialized = true; } } }); } } function tryToInitializeOutstream() { const wrapper = getWrapper(); if (wrapper) { const containerOffset = wrapper.getBoundingClientRect(); const windowHeight = window.innerHeight; if (containerOffset.top < windowHeight / 1 && containerOffset.bottom > 0.0) { if (cpexPackage.adserver.displayed) { clearInterval(outstreamInitInterval); outstreamInit(); } } } else { clearInterval(outstreamInitInterval); } } }
OSZAR »