Class: Kamal::Cli::Build

Inherits:
Base
  • Object
show all
Defined in:
lib/kamal/cli/build.rb

Defined Under Namespace

Classes: BuildError, Clone, PortForwarding

Instance Method Summary collapse

Methods inherited from Base

dynamic_command_class, exit_on_failure?, #initialize

Constructor Details

This class inherits a constructor from Kamal::Cli::Base

Instance Method Details

#create ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/kamal/cli/build.rb', line 87

def create
  if (remote_host = KAMAL.config.builder.remote)
    connect_to_remote_host(remote_host)
  end

  run_locally do
    begin
      debug "Using builder: #{KAMAL.builder.name}"
      execute *KAMAL.builder.create
    rescue SSHKit::Command::Failed => e
      if e.message =~ /stderr=(.*)/
        error "Couldn't create remote builder: #{$1}"
        false
      else
        raise
      end
    end
  end
end

#deliver ⇒ Object 



5
6
7
8
 
# File 'lib/kamal/cli/build.rb', line 5

def deliver
  invoke :push
  invoke :pull
end

#details ⇒ Object 



116
117
118
119
120
121
 
# File 'lib/kamal/cli/build.rb', line 116

def details
  run_locally do
    puts "Builder: #{KAMAL.builder.name}"
    puts capture(*KAMAL.builder.info)
  end
end

#dev ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/kamal/cli/build.rb', line 126

def dev
  cli = self

  ensure_docker_installed

  docker_included_files = Set.new(Kamal::Docker.included_files)
  git_uncommitted_files = Set.new(Kamal::Git.uncommitted_files)
  git_untracked_files = Set.new(Kamal::Git.untracked_files)

  docker_uncommitted_files = docker_included_files & git_uncommitted_files
  if docker_uncommitted_files.any?
    say "WARNING: Files with uncommitted changes will be present in the dev container:", :yellow
    docker_uncommitted_files.sort.each { |f| say "  #{f}", :yellow }
    say
  end

  docker_untracked_files = docker_included_files & git_untracked_files
  if docker_untracked_files.any?
    say "WARNING: Untracked files will be present in the dev container:", :yellow
    docker_untracked_files.sort.each { |f| say "  #{f}", :yellow }
    say
  end

  with_env(KAMAL.config.builder.secrets) do
    run_locally do
      build = KAMAL.builder.push(cli.options[:output], tag_as_dirty: true, no_cache: cli.options[:no_cache])
      KAMAL.with_verbosity(:debug) do
        execute(*build)
      end
    end
  end
end

#pull ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/kamal/cli/build.rb', line 70

def pull
   unless KAMAL.registry.local?

  forward_local_registry_port(KAMAL.hosts, **KAMAL.config.ssh.options) do
    if (first_hosts = mirror_hosts).any?
      #  Pull on a single host per mirror first to seed them
      say "Pulling image on #{first_hosts.join(", ")} to seed the #{"mirror".pluralize(first_hosts.count)}...", :magenta
      pull_on_hosts(first_hosts)
      say "Pulling image on remaining hosts...", :magenta
      pull_on_hosts(KAMAL.app_hosts - first_hosts)
    else
      pull_on_hosts(KAMAL.app_hosts)
    end
  end
end

#push ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/kamal/cli/build.rb', line 13

def push
  cli = self

  # Ensure pre-connect hooks run before the build, they may needed for a remote builder
  # or the pre-build hooks.
  pre_connect_if_required

  ensure_docker_installed
   if KAMAL.builder.

  run_hook "pre-build"

  uncommitted_changes = Kamal::Git.uncommitted_changes

  if KAMAL.config.builder.git_clone?
    if uncommitted_changes.present?
      say "Building from a local git clone, so ignoring these uncommitted changes:\n #{uncommitted_changes}", :yellow
    end

    run_locally do
      Clone.new(self).prepare
    end
  elsif uncommitted_changes.present?
    say "Building with uncommitted changes:\n #{uncommitted_changes}", :yellow
  end

  forward_local_registry_port_for_remote_builder do
    with_env(KAMAL.config.builder.secrets) do
      run_locally do
        begin
          execute *KAMAL.builder.inspect_builder
        rescue SSHKit::Command::Failed => e
          if e.message =~ /(context not found|no builder|no compatible builder|does not exist)/
            warn "Missing compatible builder, so creating a new one first"
            begin
              cli.remove
            rescue SSHKit::Command::Failed
              raise unless e.message =~ /(context not found|no builder|does not exist)/
            end
            cli.create
          else
            raise
          end
        end

        # Get the command here to ensure the Dir.chdir doesn't interfere with it
        push = KAMAL.builder.push(cli.options[:output], no_cache: cli.options[:no_cache])

        KAMAL.with_verbosity(:debug) do
          Dir.chdir(KAMAL.config.builder.build_directory) { execute *push, env: KAMAL.builder.push_env }
        end
      end
    end
  end
end

#remove ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/kamal/cli/build.rb', line 108

def remove
  run_locally do
    debug "Using builder: #{KAMAL.builder.name}"
    execute *KAMAL.builder.remove
  end
end