mirror of
https://github.com/apricote/hcloud-upload-image.git
synced 2026-02-06 17:57:06 +00:00
feat: documentation and cleanup command
This commit is contained in:
parent
27d4e3240e
commit
c9ab40b539
16 changed files with 394 additions and 148 deletions
|
|
@ -1,285 +0,0 @@
|
|||
package hcloudimages
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/hetznercloud/hcloud-go/v2/hcloud"
|
||||
"golang.org/x/crypto/ssh"
|
||||
|
||||
"github.com/apricote/hcloud-upload-image/hcloudimages/contextlogger"
|
||||
"github.com/apricote/hcloud-upload-image/hcloudimages/internal/control"
|
||||
"github.com/apricote/hcloud-upload-image/hcloudimages/internal/randomid"
|
||||
"github.com/apricote/hcloud-upload-image/hcloudimages/internal/sshkey"
|
||||
"github.com/apricote/hcloud-upload-image/hcloudimages/internal/sshsession"
|
||||
)
|
||||
|
||||
const (
|
||||
CreatedByLabel = "apricote.de/created-by"
|
||||
CreatedByValue = "hcloud-upload-image"
|
||||
|
||||
resourcePrefix = "hcloud-upload-image-"
|
||||
)
|
||||
|
||||
var (
|
||||
DefaultLabels = map[string]string{
|
||||
CreatedByLabel: CreatedByValue,
|
||||
}
|
||||
|
||||
serverTypePerArchitecture = map[hcloud.Architecture]*hcloud.ServerType{
|
||||
hcloud.ArchitectureX86: {Name: "cx11"},
|
||||
hcloud.ArchitectureARM: {Name: "cax11"},
|
||||
}
|
||||
|
||||
defaultImage = &hcloud.Image{Name: "ubuntu-22.04"}
|
||||
defaultLocation = &hcloud.Location{Name: "fsn1"}
|
||||
defaultRescueType = hcloud.ServerRescueTypeLinux64
|
||||
|
||||
defaultSSHDialTimeout = 1 * time.Minute
|
||||
)
|
||||
|
||||
func NewClient(c *hcloud.Client) Client {
|
||||
return &client{
|
||||
c: c,
|
||||
}
|
||||
}
|
||||
|
||||
type client struct {
|
||||
c *hcloud.Client
|
||||
}
|
||||
|
||||
func (s client) Upload(ctx context.Context, options UploadOptions) (*hcloud.Image, error) {
|
||||
logger := contextlogger.From(ctx).With(
|
||||
"library", "hcloud-upload-image",
|
||||
"method", "upload",
|
||||
)
|
||||
|
||||
id, err := randomid.Generate()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
logger = logger.With("run-id", id)
|
||||
// For simplicity, we use the name random name for SSH Key + Server
|
||||
resourceName := resourcePrefix + id
|
||||
|
||||
// 1. Create SSH Key
|
||||
logger.InfoContext(ctx, "# Step 1: Generating SSH Key")
|
||||
publicKey, privateKey, err := sshkey.GenerateKeyPair()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to generate temporary ssh key pair: %w", err)
|
||||
}
|
||||
|
||||
key, _, err := s.c.SSHKey.Create(ctx, hcloud.SSHKeyCreateOpts{
|
||||
Name: resourceName,
|
||||
PublicKey: string(publicKey),
|
||||
Labels: fullLabels(options.Labels),
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to submit temporary ssh key to API: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "Uploaded ssh key", "ssh-key-id", key.ID)
|
||||
defer func() {
|
||||
// Cleanup SSH Key
|
||||
if options.DebugSkipResourceCleanup {
|
||||
logger.InfoContext(ctx, "Cleanup: Skipping cleanup of temporary ssh key")
|
||||
return
|
||||
}
|
||||
|
||||
logger.InfoContext(ctx, "Cleanup: Deleting temporary ssh key")
|
||||
|
||||
_, err := s.c.SSHKey.Delete(ctx, key)
|
||||
if err != nil {
|
||||
logger.WarnContext(ctx, "Cleanup: ssh key could not be deleted", "error", err)
|
||||
// TODO
|
||||
}
|
||||
}()
|
||||
|
||||
// 2. Create Server
|
||||
logger.InfoContext(ctx, "# Step 2: Creating Server")
|
||||
serverType, ok := serverTypePerArchitecture[options.Architecture]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("unknown architecture %q, valid options: %q, %q", options.Architecture, hcloud.ArchitectureX86, hcloud.ArchitectureARM)
|
||||
}
|
||||
|
||||
logger.DebugContext(ctx, "creating server with config",
|
||||
"image", defaultImage.Name,
|
||||
"location", defaultLocation.Name,
|
||||
"serverType", serverType.Name,
|
||||
)
|
||||
serverCreateResult, _, err := s.c.Server.Create(ctx, hcloud.ServerCreateOpts{
|
||||
Name: resourceName,
|
||||
ServerType: serverType,
|
||||
|
||||
// Not used, but without this the user receives an email with a password for every created server
|
||||
SSHKeys: []*hcloud.SSHKey{key},
|
||||
|
||||
// We need to enable rescue system first
|
||||
StartAfterCreate: hcloud.Ptr(false),
|
||||
// Image will never be booted, we only boot into rescue system
|
||||
Image: defaultImage,
|
||||
Location: defaultLocation,
|
||||
Labels: fullLabels(options.Labels),
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("creating the temporary server failed: %w", err)
|
||||
}
|
||||
logger = logger.With("server", serverCreateResult.Server.ID)
|
||||
logger.DebugContext(ctx, "Created Server")
|
||||
|
||||
logger.DebugContext(ctx, "waiting on actions")
|
||||
err = s.c.Action.WaitFor(ctx, append(serverCreateResult.NextActions, serverCreateResult.Action)...)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("creating the temporary server failed: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "actions finished")
|
||||
|
||||
server := serverCreateResult.Server
|
||||
defer func() {
|
||||
// Cleanup Server
|
||||
if options.DebugSkipResourceCleanup {
|
||||
logger.InfoContext(ctx, "Cleanup: Skipping cleanup of temporary server")
|
||||
return
|
||||
}
|
||||
|
||||
logger.InfoContext(ctx, "Cleanup: Deleting temporary server")
|
||||
|
||||
_, _, err := s.c.Server.DeleteWithResult(ctx, server)
|
||||
if err != nil {
|
||||
logger.WarnContext(ctx, "Cleanup: server could not be deleted", "error", err)
|
||||
}
|
||||
}()
|
||||
|
||||
// 3. Activate Rescue System
|
||||
logger.InfoContext(ctx, "# Step 4: Activating Rescue System")
|
||||
enableRescueResult, _, err := s.c.Server.EnableRescue(ctx, server, hcloud.ServerEnableRescueOpts{
|
||||
Type: defaultRescueType,
|
||||
SSHKeys: []*hcloud.SSHKey{key},
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("enabling the rescue system on the temporary server failed: %w", err)
|
||||
}
|
||||
|
||||
logger.DebugContext(ctx, "rescue system requested, waiting on action")
|
||||
|
||||
err = s.c.Action.WaitFor(ctx, enableRescueResult.Action)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("enabling the rescue system on the temporary server failed: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "action finished, rescue system enabled")
|
||||
|
||||
// 4. Boot Server
|
||||
logger.InfoContext(ctx, "# Step 4: Booting Server")
|
||||
powerOnAction, _, err := s.c.Server.Poweron(ctx, server)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("starting the temporary server failed: %w", err)
|
||||
}
|
||||
|
||||
logger.DebugContext(ctx, "boot requested, waiting on action")
|
||||
|
||||
err = s.c.Action.WaitFor(ctx, powerOnAction)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("starting the temporary server failed: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "action finished, server is booting")
|
||||
|
||||
// 5. Open SSH Session
|
||||
logger.InfoContext(ctx, "# Step 5: Opening SSH Connection")
|
||||
signer, err := ssh.ParsePrivateKey(privateKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("parsing the automatically generated temporary private key failed: %w", err)
|
||||
}
|
||||
|
||||
sshClientConfig := &ssh.ClientConfig{
|
||||
User: "root",
|
||||
Auth: []ssh.AuthMethod{
|
||||
ssh.PublicKeys(signer),
|
||||
},
|
||||
// There is no way to get the host key of the rescue system beforehand
|
||||
HostKeyCallback: ssh.InsecureIgnoreHostKey(),
|
||||
Timeout: defaultSSHDialTimeout,
|
||||
}
|
||||
|
||||
// the server needs some time until its properly started and ssh is available
|
||||
var sshClient *ssh.Client
|
||||
|
||||
err = control.Retry(
|
||||
contextlogger.New(ctx, logger.With("operation", "ssh")),
|
||||
10,
|
||||
func() error {
|
||||
var err error
|
||||
logger.DebugContext(ctx, "trying to connect to server", "ip", server.PublicNet.IPv4.IP)
|
||||
sshClient, err = ssh.Dial("tcp", server.PublicNet.IPv4.IP.String()+":ssh", sshClientConfig)
|
||||
return err
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to ssh into temporary server: %w", err)
|
||||
}
|
||||
defer sshClient.Close()
|
||||
|
||||
// 6. SSH On Server: Download Image, Decompress, Write to Root Disk
|
||||
logger.InfoContext(ctx, "# Step 6: Downloading image and writing to disk")
|
||||
decompressionCommand := ""
|
||||
if options.ImageCompression != CompressionNone {
|
||||
switch options.ImageCompression {
|
||||
case CompressionBZ2:
|
||||
decompressionCommand += "| bzip2 -cd"
|
||||
default:
|
||||
return nil, fmt.Errorf("unknown compression: %q", options.ImageCompression)
|
||||
}
|
||||
}
|
||||
|
||||
fullCmd := fmt.Sprintf("wget --no-verbose -O - %q %s | dd of=/dev/sda bs=4M && sync", options.ImageURL.String(), decompressionCommand)
|
||||
logger.DebugContext(ctx, "running download, decompress and write to disk command", "cmd", fullCmd)
|
||||
|
||||
output, err := sshsession.Run(sshClient, fullCmd)
|
||||
logger.InfoContext(ctx, "# Step 6: Finished writing image to disk")
|
||||
logger.DebugContext(ctx, string(output))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to download and write the image: %w", err)
|
||||
}
|
||||
|
||||
// 7. SSH On Server: Shutdown
|
||||
logger.InfoContext(ctx, "# Step 7: Shutting down server")
|
||||
_, err = sshsession.Run(sshClient, "shutdown now")
|
||||
if err != nil {
|
||||
// TODO Verify if shutdown error, otherwise return
|
||||
logger.WarnContext(ctx, "shutdown returned error", "err", err)
|
||||
}
|
||||
|
||||
// 8. Create Image from Server
|
||||
logger.InfoContext(ctx, "# Step 8: Creating Image")
|
||||
createImageResult, _, err := s.c.Server.CreateImage(ctx, server, &hcloud.ServerCreateImageOpts{
|
||||
Type: hcloud.ImageTypeSnapshot,
|
||||
Description: options.Description,
|
||||
Labels: fullLabels(options.Labels),
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create snapshot: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "image creation requested, waiting on action")
|
||||
|
||||
err = s.c.Action.WaitFor(ctx, createImageResult.Action)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create snapshot: %w", err)
|
||||
}
|
||||
logger.DebugContext(ctx, "action finished, image was created")
|
||||
|
||||
image := createImageResult.Image
|
||||
logger.InfoContext(ctx, "# Image was created", "image", image.ID)
|
||||
|
||||
// Resource cleanup is happening in `defer`
|
||||
return image, nil
|
||||
}
|
||||
|
||||
func fullLabels(userLabels map[string]string) map[string]string {
|
||||
if userLabels == nil {
|
||||
userLabels = make(map[string]string, len(DefaultLabels))
|
||||
}
|
||||
for k, v := range DefaultLabels {
|
||||
userLabels[k] = v
|
||||
}
|
||||
|
||||
return userLabels
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue