Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

log submariner component's version on startup #2552

Merged
merged 2 commits into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ endif
include $(SHIPYARD_DIR)/Makefile.inc

TARGETS := $(shell ls -p scripts | grep -v -e /)
export LDFLAGS = -X main.VERSION=$(VERSION)
cyclinder marked this conversation as resolved.
Show resolved Hide resolved

GIT_COMMIT_HASH := $(shell git show -s --format='format:%H')
GIT_COMMIT_DATE := $(shell git show -s --format='format:%cI')
VERSIONS_MODULE := github.com/submariner-io/submariner/pkg/versions
export LDFLAGS = -X $(VERSIONS_MODULE).version=$(VERSION) \
-X $(VERSIONS_MODULE).gitCommitHash=$(GIT_COMMIT_HASH) \
-X $(VERSIONS_MODULE).gitCommitDate=$(GIT_COMMIT_DATE)
ifneq (,$(filter external-net,$(_using)))
export TESTDIR = test/external
override export PLUGIN = scripts/e2e/external/hook
Expand Down
6 changes: 4 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import (
"github.com/submariner-io/submariner/pkg/natdiscovery"
"github.com/submariner-io/submariner/pkg/pod"
"github.com/submariner-io/submariner/pkg/types"
"github.com/submariner-io/submariner/pkg/versions"
corev1 "k8s.io/api/core/v1"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/kubernetes"
Expand Down Expand Up @@ -104,7 +105,6 @@ const (
)

var (
VERSION = "not-compiled-properly"
logger = log.Logger{Logger: logf.Log.WithName("main")}
lastBadCertificate atomic.Value
)
Expand All @@ -114,6 +114,8 @@ func main() {
flag.Parse()
kzerolog.InitK8sLogging()

versions.Log(&logger)

logger.Info("Starting the submariner gateway engine")

components := &componentsType{
Expand Down Expand Up @@ -185,7 +187,7 @@ func main() {
components.cableEngineSyncer = syncer.NewGatewaySyncer(
components.cableEngine,
submarinerClient.SubmarinerV1().Gateways(components.submSpec.Namespace),
VERSION, components.cableHealthChecker)
versions.Submariner(), components.cableHealthChecker)

if components.submSpec.Uninstall {
logger.Info("Uninstalling the submariner gateway engine")
Expand Down
3 changes: 3 additions & 0 deletions pkg/globalnet/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (
"github.com/submariner-io/submariner/pkg/cidr"
submarinerClientset "github.com/submariner-io/submariner/pkg/client/clientset/versioned"
"github.com/submariner-io/submariner/pkg/globalnet/controllers"
"github.com/submariner-io/submariner/pkg/versions"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/tools/clientcmd"
Expand All @@ -54,6 +55,8 @@ func main() {
flag.Parse()
kzerolog.InitK8sLogging()

versions.Log(&logger)

var spec controllers.Specification

err := envconfig.Process("submariner", &spec)
Expand Down
3 changes: 3 additions & 0 deletions pkg/networkplugin-syncer/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (
eventlogger "github.com/submariner-io/submariner/pkg/event/logger"
"github.com/submariner-io/submariner/pkg/networkplugin-syncer/handlers/ovn"
"github.com/submariner-io/submariner/pkg/routeagent_driver/environment"
"github.com/submariner-io/submariner/pkg/versions"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
Expand All @@ -49,6 +50,8 @@ func main() {
flag.Parse()
kzerolog.InitK8sLogging()

versions.Log(&logger)

logger.Info("Starting submariner-networkplugin-syncer")
// set up signals so we handle the first shutdown signal gracefully
stopCh := signals.SetupSignalHandler().Done()
Expand Down
3 changes: 3 additions & 0 deletions pkg/routeagent_driver/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import (
"github.com/submariner-io/submariner/pkg/routeagent_driver/handlers/kubeproxy"
"github.com/submariner-io/submariner/pkg/routeagent_driver/handlers/mtu"
"github.com/submariner-io/submariner/pkg/routeagent_driver/handlers/ovn"
"github.com/submariner-io/submariner/pkg/versions"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/clientcmd"
logf "sigs.k8s.io/controller-runtime/pkg/log"
Expand All @@ -59,6 +60,8 @@ func main() {
flag.Parse()
kzerolog.InitK8sLogging()

versions.Log(&logger)

logger.Info("Starting submariner-route-agent using the event framework")
// set up signals so we handle the first shutdown signal gracefully
stopCh := signals.SetupSignalHandler().Done()
Expand Down
45 changes: 45 additions & 0 deletions pkg/versions/version.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
SPDX-License-Identifier: Apache-2.0
Copyright Contributors to the Submariner project.
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 versions

import (
"fmt"
"runtime"

"github.com/submariner-io/admiral/pkg/log"
)

var (
version = "devel"
gitCommitHash string
gitCommitDate string
)

func Log(logger *log.Logger) {
logger.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
logger.Info(fmt.Sprintf("Go Arch: %s", runtime.GOARCH))
logger.Info(fmt.Sprintf("Git Commit Hash: %s", gitCommitHash))
logger.Info(fmt.Sprintf("Git Commit Date: %s", gitCommitDate))
logger.Info(fmt.Sprintf("Submariner Version: %s", version))
}

// Submariner returns the version info of submariner.
func Submariner() string {
return version
}
Loading