server: Move all the top level files into cmd folder. (#2490)

This change brings a change which was done for the 'mc' package to allow for clean repo and have a cleaner github drop in experience.
2026-07-21 21:20:23 +03:00 · 2016-08-18 16:23:42 -07:00
parent 73d1a46f3e
commit bccf549463
187 changed files with 425 additions and 419 deletions
@@ -0,0 +1,278 @@
+/*
+ * Minio Cloud Storage, (C) 2015, 2016 Minio, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package cmd
+
+import (
+	"fmt"
+	"net"
+	"net/http"
+	"os"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/minio/cli"
+)
+
+var serverCmd = cli.Command{
+	Name:  "server",
+	Usage: "Start object storage server.",
+	Flags: []cli.Flag{
+		cli.StringFlag{
+			Name:  "address",
+			Value: ":9000",
+			Usage: "Specify custom server \"ADDRESS:PORT\", defaults to \":9000\".",
+		},
+		cli.StringFlag{
+			Name:  "ignore-disks",
+			Usage: "Specify comma separated list of disks that are offline.",
+		},
+	},
+	Action: serverMain,
+	CustomHelpTemplate: `NAME:
+  minio {{.Name}} - {{.Usage}}
+
+USAGE:
+  minio {{.Name}} [OPTIONS] PATH [PATH...]
+
+OPTIONS:
+  {{range .Flags}}{{.}}
+  {{end}}
+ENVIRONMENT VARIABLES:
+  ACCESS:
+     MINIO_ACCESS_KEY: Access key string of 5 to 20 characters in length.
+     MINIO_SECRET_KEY: Secret key string of 8 to 40 characters in length.
+
+  CACHING:
+     MINIO_CACHE_SIZE: Set total cache size in NN[GB|MB|KB]. Defaults to 8GB.
+     MINIO_CACHE_EXPIRY: Set cache expiration duration in NN[h|m|s]. Defaults to 72 hours.
+
+EXAMPLES:
+  1. Start minio server.
+      $ minio {{.Name}} /home/shared
+
+  2. Start minio server bound to a specific IP:PORT, when you have multiple network interfaces.
+      $ minio {{.Name}} --address 192.168.1.101:9000 /home/shared
+
+  3. Start minio server on Windows.
+      $ minio {{.Name}} C:\MyShare
+
+  4. Start minio server on 12 disks to enable erasure coded layer with 6 data and 6 parity.
+      $ minio {{.Name}} /mnt/export1/backend /mnt/export2/backend /mnt/export3/backend /mnt/export4/backend \
+          /mnt/export5/backend /mnt/export6/backend /mnt/export7/backend /mnt/export8/backend /mnt/export9/backend \
+          /mnt/export10/backend /mnt/export11/backend /mnt/export12/backend
+
+  5. Start minio server on 12 disks while ignoring two disks for initialization.
+      $ minio {{.Name}} --ignore-disks=/mnt/export1/backend,/mnt/export2/backend /mnt/export1/backend \
+          /mnt/export2/backend /mnt/export3/backend /mnt/export4/backend /mnt/export5/backend /mnt/export6/backend \
+          /mnt/export7/backend /mnt/export8/backend /mnt/export9/backend /mnt/export10/backend /mnt/export11/backend \
+          /mnt/export12/backend
+`,
+}
+
+type serverCmdConfig struct {
+	serverAddr   string
+	disks        []string
+	ignoredDisks []string
+}
+
+// getListenIPs - gets all the ips to listen on.
+func getListenIPs(httpServerConf *http.Server) (hosts []string, port string) {
+	host, port, err := net.SplitHostPort(httpServerConf.Addr)
+	fatalIf(err, "Unable to parse host address.", httpServerConf.Addr)
+
+	if host != "" {
+		hosts = append(hosts, host)
+		return hosts, port
+	}
+	addrs, err := net.InterfaceAddrs()
+	fatalIf(err, "Unable to determine network interface address.")
+	for _, addr := range addrs {
+		if addr.Network() == "ip+net" {
+			host := strings.Split(addr.String(), "/")[0]
+			if ip := net.ParseIP(host); ip.To4() != nil {
+				hosts = append(hosts, host)
+			}
+		}
+	}
+	return hosts, port
+}
+
+// Finalizes the endpoints based on the host list and port.
+func finalizeEndpoints(tls bool, apiServer *http.Server) (endPoints []string) {
+	// Get list of listen ips and port.
+	hosts, port := getListenIPs(apiServer)
+
+	// Verify current scheme.
+	scheme := "http"
+	if tls {
+		scheme = "https"
+	}
+
+	ips := getIPsFromHosts(hosts)
+
+	// Construct proper endpoints.
+	for _, ip := range ips {
+		endPoints = append(endPoints, fmt.Sprintf("%s://%s:%s", scheme, ip.String(), port))
+	}
+
+	// Success.
+	return endPoints
+}
+
+// initServerConfig initialize server config.
+func initServerConfig(c *cli.Context) {
+	// Create certs path.
+	err := createCertsPath()
+	fatalIf(err, "Unable to create \"certs\" directory.")
+
+	// Fetch max conn limit from environment variable.
+	if maxConnStr := os.Getenv("MINIO_MAXCONN"); maxConnStr != "" {
+		// We need to parse to its integer value.
+		globalMaxConn, err = strconv.Atoi(maxConnStr)
+		fatalIf(err, "Unable to convert MINIO_MAXCONN=%s environment variable into its integer value.", maxConnStr)
+	}
+
+	// Fetch max cache size from environment variable.
+	if maxCacheSizeStr := os.Getenv("MINIO_CACHE_SIZE"); maxCacheSizeStr != "" {
+		// We need to parse cache size to its integer value.
+		globalMaxCacheSize, err = strconvBytes(maxCacheSizeStr)
+		fatalIf(err, "Unable to convert MINIO_CACHE_SIZE=%s environment variable into its integer value.", maxCacheSizeStr)
+	}
+
+	// Fetch cache expiry from environment variable.
+	if cacheExpiryStr := os.Getenv("MINIO_CACHE_EXPIRY"); cacheExpiryStr != "" {
+		// We need to parse cache expiry to its time.Duration value.
+		globalCacheExpiry, err = time.ParseDuration(cacheExpiryStr)
+		fatalIf(err, "Unable to convert MINIO_CACHE_EXPIRY=%s environment variable into its time.Duration value.", cacheExpiryStr)
+	}
+
+	// Fetch access keys from environment variables if any and update the config.
+	accessKey := os.Getenv("MINIO_ACCESS_KEY")
+	secretKey := os.Getenv("MINIO_SECRET_KEY")
+
+	// Validate if both keys are specified and they are valid save them.
+	if accessKey != "" && secretKey != "" {
+		if !isValidAccessKey.MatchString(accessKey) {
+			fatalIf(errInvalidArgument, "Invalid access key.")
+		}
+		if !isValidSecretKey.MatchString(secretKey) {
+			fatalIf(errInvalidArgument, "Invalid secret key.")
+		}
+		// Set new credentials.
+		serverConfig.SetCredential(credential{
+			AccessKeyID:     accessKey,
+			SecretAccessKey: secretKey,
+		})
+		// Save new config.
+		err = serverConfig.Save()
+		fatalIf(err, "Unable to save config.")
+	}
+
+	// Set maxOpenFiles, This is necessary since default operating
+	// system limits of 1024, 2048 are not enough for Minio server.
+	setMaxOpenFiles()
+	// Set maxMemory, This is necessary since default operating
+	// system limits might be changed and we need to make sure we
+	// do not crash the server so the set the maxCacheSize appropriately.
+	setMaxMemory()
+
+	// Do not fail if this is not allowed, lower limits are fine as well.
+}
+
+// Check server arguments.
+func checkServerSyntax(c *cli.Context) {
+	if !c.Args().Present() || c.Args().First() == "help" {
+		cli.ShowCommandHelpAndExit(c, "server", 1)
+	}
+}
+
+// Extract port number from address address should be of the form host:port.
+func getPort(address string) int {
+	_, portStr, _ := net.SplitHostPort(address)
+	// If port empty, default to port '80'
+	if portStr == "" {
+		portStr = "80"
+		// if SSL is enabled, choose port as "443" instead.
+		if isSSL() {
+			portStr = "443"
+		}
+	}
+
+	// Return converted port number.
+	portInt, err := strconv.Atoi(portStr)
+	fatalIf(err, "Invalid port number.")
+	return portInt
+}
+
+// serverMain handler called for 'minio server' command.
+func serverMain(c *cli.Context) {
+	// Check 'server' cli arguments.
+	checkServerSyntax(c)
+
+	// Initialize server config.
+	initServerConfig(c)
+
+	// If https.
+	tls := isSSL()
+
+	// Server address.
+	serverAddress := c.String("address")
+
+	// Check if requested port is available.
+	port := getPort(serverAddress)
+	err := checkPortAvailability(port)
+	fatalIf(err, "Port unavailable %d", port)
+
+	// Disks to be ignored in server init, to skip format healing.
+	ignoredDisks := strings.Split(c.String("ignore-disks"), ",")
+
+	// Disks to be used in server init.
+	disks := c.Args()
+
+	// Configure server.
+	handler := configureServerHandler(serverCmdConfig{
+		serverAddr:   serverAddress,
+		disks:        disks,
+		ignoredDisks: ignoredDisks,
+	})
+
+	apiServer := NewMuxServer(serverAddress, handler)
+
+	// Fetch endpoints which we are going to serve from.
+	endPoints := finalizeEndpoints(tls, &apiServer.Server)
+
+	// Prints the formatted startup message.
+	printStartupMessage(endPoints)
+
+	// Register generic callbacks.
+	globalShutdownCBs.AddGenericCB(func() errCode {
+		// apiServer.Stop()
+		return exitSuccess
+	})
+
+	// Start server.
+	// Configure TLS if certs are available.
+	if tls {
+		err = apiServer.ListenAndServeTLS(mustGetCertFile(), mustGetKeyFile())
+	} else {
+		// Fallback to http.
+		err = apiServer.ListenAndServe()
+	}
+
+	fatalIf(err, "Failed to start minio server.")
+}