Project

General

Profile

Actions

DDB CMS Manualen - Webmaster kontrolpanel - NEXT VERSION

Gem manualen som PDF

Om vejledningen:

Vejledningen er målrettet webmasterbiblioteker, der har adgang til kontrolpanelet og beskriver hvordan panelet bruges.
Manualen forudsætter, at du har grundlæggende drupalkompetencer på webmasterniveau og kan installere, aktivere og konfigurere moduler.

Til inspiration kan du se moduler andre biblioteker har installeret, eller eksperimenteret med. (Seneste opdateret 5. december 2016)

Anvendt notation:

Notation

Nogle steder i vejledningen er der behov for at henvise til hele eller dele af URL'en.

Det foregår sådan:

  • Tekst i “[ ]” indikerer, at der er forskelle alt efter hvilket biblioteks hjemmeside der henvises til.
  • Ved henvisning til undersider udelades bibliotekets adresse så "http://www.biblioteketsnavn.dk" fjernes og det er kun den relative-URL, der er tilbage f.eks. “/stiens navn”
  • Ved henvisninger til undersider, der er individuelle for hvert biblioteket indsættes [BIBLIOTEKETS_NAVN] i URL'en.

Sti til funktioner

I nogle afsnit beskrives funktioner, hvor en admin-sti er angivet i parantes.
f.eks.(Sti: admin/structure/menu/manage/main-menu).

Du kan bruge stien i stedet for at klikke dig frem til den pågældende funktion.

Du kan enten skrive stien ind direkte efter hjemmesidenavnet (husk / efter hjemmesidenavnet):
f.eks. []/admin/structure/menu/manage/main-menu

Eller du kan på alle jeres sider efter sidens adresse skrive #overlay= og derefter stien:
f.eks. []/arrangementer#overlay=admin/config/ting/resevable

Hvad er kontrolpanelet?

Kontrolpanelet giver mulighed for at tilføje ny funktionalitet til DDB CMS og fikserer udrulningsprocessen i et forløb, der understøtter kvalitetssikring og test. Det giver bl.a. mulighed for at:

  • Installere nye moduler og themes på bibliotekets hjemmeside der ikke er en del af DDB CMS’ standardpakke.
  • Selv styre opdateringen af DDB CMS platformen når der frigives nye versioner.
  • Administrere miljøer, der understøtter forskellige faser i udrulningsforløbet.

Kontrolpanelet findes under “DDB -> Udvikling” (Sti: admin/ddb_cp/development).

For at anvende panelet er det nødvendigt, at du logger ind med en administrator-bruger. Administrator-brugeren udleveres af DDB. Bemærk at lokalt oprettede administratorer i øjeblikket ikke har adgang til kontrolpanelet. Det vil blive muligt i den nærmere fremtid.

Husk at alle, der benytter administratorrollen, skal læse brugsbetingelserne for webmasterhostingplanen.

Udrulningen sker i tre faser.

Alle nye moduler, der ønskes udrullet på DDB CMS skal igennem tre faser, som forløber sekventielt. Faserne består af:

  • En udviklingsfase
  • En stagingfase
  • En produktionsfase

Hver fase er tilknyttet et DDB CMS site.

Formålet med faseinddelingen er bl.a. at teste og kvalitetssikre ændringer, før de eksponeres for sidens brugere.

Udrulningsforløb med kontrolpanelet

Kontrolpanelet giver mulighed for at oprette og administrere de tre sites, der indgår i udrulningsprocessen. Det sker fra de tre faner vist nedenfor:

Hver af fanerne kan foldes ud og indeholder knapper til administration af de pågældende miljøer dvs. oprettelse, sletning, test og opdatering. Knapper til at slette, teste og opdatere vil først være tilgængelige, når der er oprettet et site af den specifikke type.

Nedenfor er en kort beskrivelse af de tre sites, og hvad de er beregnet til:

Udviklersite

Udviklersite: Når du opretter et udviklersite via kontrolpanelet, dannes en særskilt hjemmeside, hvor du kan starte udrulningen. Hjemmesiden er enten en kopi af dit produktionssite (se beskrivelse af produktionssite nedenfor) eller en af de tilgængelige platforme og databaseindholdet fra produktionsmiljøet (mere om det senere). Det vælger du med radioknapperne under fanen “Developer site”. På illustrationen nedenunder er “Current” valgt som platform, hvilket betyder at udviklersitet bliver baseret på en kopi af produktionssitet.

Når man har oprettet et site, kan man under “Site status” se status for oprettelsen af sitet:

Når udviklingssitet er oprettet linkes der fra kontrolpanelet til sitet:

Udviklersitet bliver typisk brugt til indledende afprøvning og test af nye moduler, f.eks. som led i modningsforløb under udvikling af modulet. Hvis modulet eller ændringen godkendes, opretter man et stagingsite, hvor modulet automatisk flyttes over. Ønsker man ikke at fortsætte udviklingsforløbet, f.eks. hvis et modul ikke fungerer tilfredsstillende, kan udviklersitet slettes.

Stagingsite

Stagingsite: Når du opretter et stagingsitet via kontrolpanelet, dannes et nyt site baseret på en kopi af koden fra dit udviklersite og databaseindholdet fra produktionssitet. Stagingsitet bruges ofte til test af mere produktionsklar funktionalitet, hvor der ikke er tvivl om at ændringen ønskes udrullet på produktionsmiljøet. Disse test kan involverer inddragelse af en bredere brugerskare end testene på udviklersitet. Hvis modulet eller ændringen godkendes, kan ændringen udrulles til produktionssitet. Udviklersitet vil stadig være tilgængelig, efter man har oprettet stagingsitet. Bemærk at det er muligt at rulle ændringer ud på stagingsitet, efter det er oprettet. Tryk på knappen "Opdatér" og eventuelle ændringer, der er tilføjet til udviklersitet siden oprettelsen af stagingsitet, vil blive rullet ud på stagingsitet:

Produktionssite

Produktionssite: Produktionssitet er den hjemmeside, de primære brugere (aka lånerne) har adgang til. Når du udruller ændringer til produktionssitet, betyder det, at du udruller koden fra stagingsitet til produktionssitet. Databasen på produktionssitet vil ikke blive ændret, da det er på produktionssitet der findes den seneste udgave af indholdet på sitet. Når du udruller til produktionssitet, vil udvikler- og stagingsitet parallelt blive slettet.

Kode og databaseindhold.

Når du opretter eller opdaterer et udvikler, staging eller produktionssite, er det vigtigt at være opmærksom på at sidet består af to dele; kode og databaseindhold. Koden udgøres af selve DDB CMS og databasen udgør alt det oprettede indhold på sitet og konfiguration. Konfiguration er f.eks. data om hvilke moduler, der er slået til og hvordan de konfigureret. Når du opretter eller opdaterer de forskellige sites, vil det ske på baggrund af følgende kode og databaseindhold:

Udviklersite:

Hvis man udruller et udviklersite på baggrund af sit nuværende site, vil udviklingssitet blive dannet på baggrund af koden og databasen fra produktionssitet.
Hvis man udruller et udviklingssite baseret på en ny platform, vil udviklingssitet bestå af koden fra den nye platform og databasen fra produktionssitet.

Stagingsite:

Stagingsitet vil blive dannet på baggrund af koden fra udviklingssitet og databasen fra produktionssitet.

Produktionssite:

Når man opdaterer produktionssitet er det altid kun koden på sitet, der bliver ændret. Databasen vil aldrig blive ændret, da den indeholder det seneste indhold på sitet.

Sådan virker de automatiske tests

I udviklings- og stagingfasen afvikles der automatiske test, hvis formål er at sikre, at ny kode ikke forårsager fejl og ødelægger systemkritisk funktionalitet i DDB CMS.
Før det er muligt at fortsætte til næste fase, skal koden bestå testen. Det er f.eks. ikke muligt at gå fra udviklingsfasen til stagingfasen med mindre testen i udviklingsmiljøet er godkendt.
I øjeblikket afvikles der kun en dummy-test (se illustration nedenfor), men på et senere tidspunkt vil der blive implementeret en fungerende test i kontrolpanelet. Derfor er det særligt vigtigt at være grundig med den manuelle test. Oplysningerne om resultatet af en automatisk test vises under “Test status” - se illustrationen nedenfor. Herfra har man også mulighed for at igangsætte en automatisk test med knappen “Run new test”. Det kan f.eks. være relevant, hvis man udruller ny funktionalitet på udviklingssitet over flere omgange.

Fejlhåndtering og backups

Hver gang der udrulles ændringer til produktionssitet, laves en automatisk backup af dit produktionsmiljø. I tilfælde af at der sker fejl i forbindelse med udrulningen, er det derfor muligt at gendanne hjemmesiden, som den så ud før udrulningen. Det er endnu ikke muligt manuelt at lave backups fra kontrolpanelet.

Hvis du ønsker at gendanne dit site fra en backup, skal du kontakte DBC support, som hjælper med den videre proces.

Udrulning af nyt modul.

Eksemplet nedenunder illustrerer et komplet udrulningsforløb med kontrolpanelet:

  1. Åbn “DDB -> Udvikling” (Sti: admin/ddb_cp/development)
  2. Vælg radioknappen “Current” under fanen “Developer site”. Klik“opret” for at oprette et udviklersite baseret på det aktuelle produktionssite.
  3. Installér, aktivér og konfigurér det nye modul på udviklersitet.
  4. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  5. Opret et stagingsite under fanen “Staging site” ved at trykke på knappen “Opret”.
  6. Åbn det nye stagingsite (url’en findes i kontrolpanelet) og aktivér og konfigurér det nye modul.
  7. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  8. Under fanen “Production site” trykkes på knappen “Opdatér” for at opdatere produktionsmiljøet.
  9. Aktivér og konfigurér modulet.
  10. Lav afsluttende test på produktionsmiljøet, der bekræfter, at alt fungerer som forventet.

Udrulning af ny platform

Du kan opdatere til nye versioner af DDB CMS fra kontrolpanelet. Når du ønsker at udrulle en ny platform, skal du gennemgå de samme trin som beskrevet ovenover i afsnittet “Udrulning af modul”. Vær opmærksom på, at platformen ikke indeholder lokalt installerede moduler, men kun de moduler, der er en del af standardversionen af DDB CMS. Det er derfor nødvendigt at installere modulerne på den nye platform, som der opgraderes til, hvis du ønsker, at de skal være en del af dit produktionsmiljø.

Fremgangsmåden for udrulning af en platform er følgende:

  1. Åbn “DDB -> Udvikling” (Sti: admin/ddb_cp/development).
  2. Under fanen “Developer site” vælger du den platform, som udviklersitet skal baseres på, hvorefter at du trykker “Opret”
  3. Installér lokale moduler, der er tilgængelige på bibliotekets produktionssite. Kontrollér om modulerne er aktiveret og konfigureret.
  4. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  5. Tryk på knappen “Opret” under menuen “Staging site” for at oprette et stagingsite.
  6. Når stagingsitet er oprettet, skal du kontrollere at evt. moduler er aktiveret og konfigureret korrekt.
  7. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  8. Udrul platformen til produktionsmiljøet.
  9. Test om produktionsmiljøet fungerer som forventet.

Opdatering af lokalt installerede moduler

Det er vigtigt at holde øje med opdateringer til lokalt installerede moduler og sikre at vigtige opdateringer hurtigst muligt rulles på sitet. Særlig vigtige er opdateringer, der lukker sikkerhedshuller, som kan kompromittere sikkerheden på hjemmesiden.

Når du udruller opdateringer af dine moduler, er du nødt til at starte forfra med en standard platform og geninstallere forskellige lokalt installerede moduler. Hvis dit produktionsmiljø i øjeblikket befinder sig på “2015-3”, vælger du platformen “2015-3” og ikke platformen “Current”. Hvis du vælger “Current”, vil du ikke få lov til at installere opdateringen.

Fremgangsmåden for opdatering af moduler er følgende:

  1. Åbn “DDB -> Udvikling” (Sti: admin/ddb_cp/development).
  2. Under fanen “Developer site” vælger du radioknappen for den platform, dit nuværende produktionssite baserer sig på, hvorefter du trykker “Opret”.
  3. Installér den opdaterede version af modulet og evt. andre lokalt installerede moduler, der er tilgængeligt på produktionssitet. Kontrollér at modulerne er aktiveret og konfigureret korrekt.
  4. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  5. Opret et staging-sitet, ved at trykke “Opret” under menuen “Staging site”.
  6. Kontroller at modulerne er aktiveret og installeret korrekt på stagingsitet.
  7. Lav manuel og automatiseret test. Fortsæt når begge er godkendt.
  8. Udrul platformen til produktionsmiljøet.
  9. Test om produktionsmiljøet fungerer som forventet.

Ofte stillede spørgsmål

Hvor lang tid tager det at oprette de forskellige sites?

Oprettelsestiden for udvikler- og stagingsites afhænger bl.a. af størrelsen af kode- og filbasen, og om der er andre biblioteker, som opretter parallelt. Det vil ikke være atypisk at det tager omkring 20 minutter at udrulle et udvikler- eller stagingsite. Du kan reducere oprettelsestiden ved at sikre, at I ikke har mange tunge billeder, pdf’er eller lydfiler i jeres filbase.

Hvorfor skal jeg aktivere og konfigurere et modul igen på staging og produktionsmiljøet?

Oplysningerne om et modul er aktiveret og hvordan det er konfigureret ligger i databasen. Når man opretter et stagingmiljø vil databaseindholdet blive hentet fra produktionssitet, hvor modulet naturligvis endnu ikke er installeret. Derfor er det nødvendigt at aktivere og installere modulet igen på stagingmiljøet. Den modsatte situation opstår når man opdaterer et modul. Her vil produktionsmiljøet i forvejen indeholde modulet og de forskellige konfigurationsoplysninger bare i en ældre udgave. Når man i den situation installerer et opdateret modul på de forskellige miljøer, vil modulet som udgangspunkt være aktiveret og konfigureret.

Hvad oplever brugerne når jeg opdaterer produktionmiljøet?

I forbindelse med opdateringen er produktionsmiljø i vedligeholdelsestilstand og derfor utilgængeligt for brugerne. Brugere, som besøger sitet, mens det er i vedligeholdelsestilstand, vil blive mødt af følgende information.

Hvordan ser jeg hvilken version af DDB CMS der er installeret på min hjemmeside?

Du kan se hvilken DDB CMS version der er installeret på hjemmesiden under /admin/reports/status.

Den seneste stabile version af DDB CMS fremgår af https://github.com/ding2/ding2/releases/latest

Hvordan kan jeg afgøre hvilket miljø jeg befinder mig på?

Det er nemt at afgøre, hvilket miljø du befinder dig på - webadressen til dev-miljøet hedder f.eks. https://wstest-dev.ddbcms.dk/ og adressen til stagingsitet er tilsvarende https://wstest-stg.ddbcms.dk/.

Har det nogen indflydelse hvilket site jeg befinder mig på, når jeg bruger kontrolpanelet?

Kontrolpanelet er tilgængeligt fra alle miljøerne og opfører sig ens på tværs af disse.
Det har ingen betydning, om du bruger kontrolpanelet fra det ene eller andet site. Handlinger udført på kontrolpanelet på det ene site vil også afspejle sig i kontrolpanelet på det andet.

Updated by Tue Gaston over 1 year ago · 6 revisions