1
2
3
4
5
6
7
8
9
10
11
12
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
// Copyright (c) 2020, Control Command Inc. All rights reserved.
// Copyright (c) 2018-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cli
import (
"fmt"
"strings"
"github.com/spf13/cobra"
"github.com/sylabs/singularity/v4/docs"
"github.com/sylabs/singularity/v4/internal/pkg/client/library"
"github.com/sylabs/singularity/v4/internal/pkg/client/oci"
"github.com/sylabs/singularity/v4/internal/pkg/client/oras"
"github.com/sylabs/singularity/v4/internal/pkg/remote/endpoint"
"github.com/sylabs/singularity/v4/internal/pkg/signature"
"github.com/sylabs/singularity/v4/internal/pkg/util/fs"
"github.com/sylabs/singularity/v4/internal/pkg/util/uri"
"github.com/sylabs/singularity/v4/pkg/cmdline"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
var (
// PushLibraryURI holds the base URI to a Sylabs library API instance
PushLibraryURI string
// unsignedPush when true will allow pushing a unsigned container
unsignedPush bool
// pushDescription holds a description to be set against a library container
pushDescription string
)
// --library
var pushLibraryURIFlag = cmdline.Flag{
ID: "pushLibraryURIFlag",
Value: &PushLibraryURI,
DefaultValue: "",
Name: "library",
Usage: "the library to push to",
EnvKeys: []string{"LIBRARY"},
}
// -U|--allow-unsigned
var pushAllowUnsignedFlag = cmdline.Flag{
ID: "pushAllowUnsignedFlag",
Value: &unsignedPush,
DefaultValue: false,
Name: "allow-unsigned",
ShortHand: "U",
Usage: "do not require a signed container image",
EnvKeys: []string{"ALLOW_UNSIGNED"},
}
// -D|--description
var pushDescriptionFlag = cmdline.Flag{
ID: "pushDescriptionFlag",
Value: &pushDescription,
DefaultValue: "",
Name: "description",
ShortHand: "D",
Usage: "description for container image (library:// only)",
}
func init() {
addCmdInit(func(cmdManager *cmdline.CommandManager) {
cmdManager.RegisterCmd(PushCmd)
cmdManager.RegisterFlagForCmd(&pushLibraryURIFlag, PushCmd)
cmdManager.RegisterFlagForCmd(&pushAllowUnsignedFlag, PushCmd)
cmdManager.RegisterFlagForCmd(&pushDescriptionFlag, PushCmd)
cmdManager.RegisterFlagForCmd(&dockerHostFlag, PushCmd)
cmdManager.RegisterFlagForCmd(&dockerUsernameFlag, PushCmd)
cmdManager.RegisterFlagForCmd(&dockerPasswordFlag, PushCmd)
})
}
// PushCmd singularity push
var PushCmd = &cobra.Command{
DisableFlagsInUseLine: true,
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {
file, dest := args[0], args[1]
transport, ref := uri.Split(dest)
if transport == "" {
sylog.Fatalf("bad uri %s", dest)
}
switch transport {
case LibraryProtocol, "": // Handle pushing to a library
destRef, err := library.NormalizeLibraryRef(dest)
if err != nil {
sylog.Fatalf("Malformed library reference: %v", err)
}
if PushLibraryURI != "" && destRef.Host != "" {
sylog.Fatalf("Conflicting arguments; do not use --library with a library URI containing host name")
}
lc, err := getLibraryClientConfig(PushLibraryURI)
if err != nil {
sylog.Fatalf("Unable to get library client configuration: %v", err)
}
// Push to library requires a valid authToken
if lc.AuthToken == "" {
sylog.Fatalf("Cannot push image to library: %v", remoteWarning)
}
if unsignedPush {
sylog.Warningf("Skipping container verification")
} else {
// Check if the container has a valid signature.
co, err := getKeyserverClientOpts("", endpoint.KeyserverVerifyOp)
if err != nil {
sylog.Fatalf("Unable to get keyserver client configuration: %v", err)
}
if err := signature.Verify(cmd.Context(), file, signature.OptVerifyWithPGP(co...)); err != nil {
fmt.Printf("TIP: You can push unsigned images with 'singularity push -U %s'.\n", file)
fmt.Printf("TIP: Learn how to sign your own containers by using 'singularity help sign'\n\n")
sylog.Fatalf("Unable to upload container: unable to verify signature")
}
}
pushCfg := library.PushOptions{
Description: pushDescription,
Endpoint: currentRemoteEndpoint,
LibraryConfig: lc,
}
resp, err := library.Push(cmd.Context(), file, destRef, pushCfg)
if err != nil {
sylog.Fatalf("Unable to push image to library: %v", err)
}
// If the library supports direct upload into an OCI backing
// registry, then there is no response, and we are done.
if resp == nil {
return
}
// An older library may return a response with the container URL and
// quota information to display to the user.
used, quota := resp.Quota.QuotaUsageBytes, resp.Quota.QuotaTotalBytes
if quota == 0 {
fmt.Printf("\nLibrary storage: using %s out of unlimited quota\n", fs.FindSize(used))
} else {
fmt.Printf("\nLibrary storage: using %s out of %s quota (%.1f%% used)\n", fs.FindSize(used), fs.FindSize(quota), float64(used)/float64(quota)*100.0)
}
// If user didn't override the library URI we can show the URL to the container on the web for the current endpoint.
if PushLibraryURI == "" {
feURL, err := currentRemoteEndpoint.GetURL()
if err != nil {
sylog.Fatalf("Unable to find remote web URI %v", err)
}
fmt.Printf("Container URL: %s\n", feURL+"/"+strings.TrimPrefix(resp.ContainerURL, "/"))
}
case OrasProtocol:
if cmd.Flag(pushDescriptionFlag.Name).Changed {
sylog.Warningf("Description is not supported for push to oras. Ignoring it.")
}
ociAuth, err := makeDockerCredentials(cmd)
if err != nil {
sylog.Fatalf("Unable to make docker oci credentials: %s", err)
}
if err := oras.UploadImage(cmd.Context(), file, ref, ociAuth); err != nil {
sylog.Fatalf("Unable to push image to oci registry: %v", err)
}
sylog.Infof("Upload complete")
case DockerProtocol:
if cmd.Flag(pushDescriptionFlag.Name).Changed {
sylog.Warningf("Description is not supported for push to docker / OCI registries. Ignoring it.")
}
ociAuth, err := makeDockerCredentials(cmd)
if err != nil {
sylog.Fatalf("Unable to make docker oci credentials: %s", err)
}
if err := oci.Push(cmd.Context(), file, ref, ociAuth); err != nil {
sylog.Fatalf("Unable to push image to oci registry: %v", err)
}
sylog.Infof("Upload complete")
default:
sylog.Fatalf("Unsupported transport type: %s", transport)
}
},
Use: docs.PushUse,
Short: docs.PushShort,
Long: docs.PushLong,
Example: docs.PushExample,
}
|
