Opprette din første Deputy-pakke

En ny pakke kan initialiseres ved hjelp av kommandoen deputy create. Denne kommandoen vil be om grunnleggende informasjon om pakken.

Siden en virtuell maskin er basisen for de fleste øvelser, la oss lage en VM (Virtual Machine)-pakke for vår første øvelse.

deputy create

Når du blir bedt om det, velg vm som pakketype. Alt dette kan senere endres manuelt også.

Etter at pakken er opprettet, kan vi navigere til pakkemappen og se at den er initialisert med en src-mappe for pakkefiler, en README.md som inneholder en oversikt over pakken som også vises på Deputy-nettstedet etter publisering, og en package.toml-fil som inneholder metadata om pakken.

my-first-package
├── package.toml
├── README.md
└── src
    └── // package files //

Før vi kan publisere pakken, må vi legge til noen filer og fylle ut de gjenværende metadataene. For dette eksemplet vil vi eksportere en ferdig virtuell maskin (VM) fra vSphere-miljøet vårt og legge den til pakken. For å lage din egen, kan du enten lage en VM fra bunnen av eller modifisere en eksisterende.

Eksportere en VM fra VirtualBox eller VMware Workstation

Å eksportere en virtuell maskin (VM) kan gjøres effektivt i VirtualBox og VMware Workstation med følgende trinn:

1. VirtualBox:

   • Høyreklikk på VM-en i VirtualBox og velg "Eksporter til OCI" for å starte eksportveiviseren. Følg trinnene for å lagre VM-en som en OVA-fil.

2. VMware Workstation:

   • I VMware Workstation, høyreklikk på VM-en og velg "Eksporter til OVF". Dette starter en veiviser som veileder deg gjennom eksport av VM-en i OVF- eller OVA-format.

Pass på å koble fra unødvendige virtuelle disker, for eksempel ISO-filer, med mindre de er nødvendige for VM-ens drift for å unngå å øke filstørrelsen.

Fullføre pakken

Med vår OVA-fil klar, kan vi nå kopiere den til pakken vår. Plasseringen er ikke viktig, så lenge banen er beskrevet i package.toml-filen, men for dette eksemplet kopierer vi den til src-mappen i pakken.

Etter at OVA-en er kopiert, må vi fylle ut følgende felt i package.toml-filen:

• operating_system - operativsystemet til VM-en. Støttede verdier er:

AlmaLinux,
AmazonLinux,
Asianux,
CentOS,
Debian,
DebianGNULinux,
EComStation,
Fedora,
Flatcar,
FreeBSD,
KylinLinuxAdvancedServer,
MacOs,
MiracleLinux,
NeoKylinLinuxAdvancedServer,
OpenSuse,
OracleLinux,
OSX,
Pardus,
Photon,
RedHatEnterpriseLinux,
RockyLinux,
SCOOpenServer,
SCOUnixWare,
Solaris,
SUSELinuxEnterprise,
Ubuntu,
Windows10,
Windows11,
Windows2000,
Windows7,
Windows8,
WindowsServer2003,
WindowsServer2008,
WindowsServer2012,
WindowsServer2016,
WindowsServer2019,
WindowsServer2022,
WindowsVista,
WindowsXP

• architecture - arkitekturen til VM-en. Støttede arkitekturer er: amd64, arm64, armhf, i386
• file_path - den relative banen til OVA-filen
• accounts - tilgjengelige kontoer for VM-en. Dette trenger ikke å være en omfattende liste, bare de som øvelseslederen ønsker å bruke i øvelsen.
• default_account - standardkontoen for VM-en. - Utfaset, fjernes snart.
• categories - Valgfritt. Legg til kategorier til pakken for å gjøre den lettere å finne.

Til slutt skal package.toml-filen se slik ut:

[package]
name = "debian11-network-manager"
description = "Debian11 CLI with network-manager, curl, wget installed."
version = "0.3.0"
authors = ["Developers developers@cyber-range.no"]
license = "MIT"
readme = "README.md"
categories = ["debian", "nmcli"]

[content]
type = "vm"

[virtual-machine]
accounts = [
    { name = "root", password = "password" },
    { name = "user", password = "password" },
]
default_account = "root"
operating_system = "Debian"
architecture = "amd64"
type = "OVA"
file_path = "src/debian11-network-manager.ova"
readme_path = "README.md"

Pakken er nå klar til å publiseres. For å gjøre dette, må vi først logge inn på Deputy CLI ved hjelp av vår unike Deputy-token med kommandoen deputy login.

Merk: Denne pakken eksisterer allerede i Digital Library, og en ny versjon av den kan ikke lastes opp med mindre du er tildelt eierskap til pakken. En ny pakke med et nytt navn kan imidlertid opprettes.

• Skaffe en Deputy-token

  • Logg inn på Deputy-nettstedet og naviger til siden User > Tokens. Klikk på knappen Create Token og gi den et navn. Kopier tokenet til utklippstavlen.

• Merk: Som med andre tokens, kan den bare vises én gang. Hvis du mister den, må du opprette en ny.

• Logge inn på Deputy CLI

  • Kjør kommandoen deputy login og lim inn tokenet når du blir bedt om det.

• Publisere pakken

  • Kjør kommandoen deputy publish i pakkemappen. Dette vil laste opp pakken til Digital Library og kan vises på Deputy-nettstedet.
  • Hvis du ønsker å oppdatere pakken, må du endre versjonsnummeret i package.toml-filen og kjøre kommandoen deputy publish på nytt.
  • Hvis du ønsker å fjerne pakken, kan du gjøre dette ved å kjøre kommandoen deputy yank.