From fb3a936224cbbba178ed0dcd14977e06cee8e16c Mon Sep 17 00:00:00 2001 From: "David J. Allen" Date: Sun, 3 Nov 2024 19:53:48 -0700 Subject: [PATCH] updated all references --- .goreleaser.yaml | 18 ++++++------- CHANGELOG.md | 2 +- Makefile | 6 ++--- README.md | 4 +-- cmd/collect.go | 12 ++++----- cmd/crawl.go | 8 +++--- cmd/list.go | 2 +- cmd/login.go | 4 +-- cmd/root.go | 4 +-- cmd/scan.go | 6 ++--- cmd/update.go | 6 ++--- cmd/version.go | 2 +- internal/cache/sqlite/sqlite.go | 4 +-- internal/config.go | 2 +- internal/util/bmc.go | 47 --------------------------------- internal/version/version.go | 18 ++++++------- main.go | 2 +- pkg/bmc/bmc.go | 2 +- pkg/client/smd.go | 4 +-- pkg/collect.go | 10 +++---- pkg/crawler/main.go | 6 ++--- pkg/scan.go | 4 +-- pkg/secrets/example/main.go | 2 +- tests/api_test.go | 6 ++--- tests/compatibility_test.go | 6 ++--- 25 files changed, 70 insertions(+), 117 deletions(-) delete mode 100644 internal/util/bmc.go diff --git a/.goreleaser.yaml b/.goreleaser.yaml index df7b3c8..f4d81e9 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -14,15 +14,15 @@ builds: # export GO_VERSION=$(go version | awk '{print $3}') # export BUILD_USER=$(whoami) ldflags: - - "-X github.com/OpenCHAMI/magellan/internal/version.GitCommit={{ .Commit }} \ - -X github.com/OpenCHAMI/magellan/internal/version.BuildTime={{ .Timestamp }} \ - -X github.com/OpenCHAMI/magellan/internal/version.Version={{ .Version }} \ - -X github.com/OpenCHAMI/magellan/internal/version.GitBranch={{ .Branch }} \ - -X github.com/OpenCHAMI/magellan/internal/version.GitTag={{ .Tag }} \ - -X github.com/OpenCHAMI/magellan/internal/version.GitState={{ .Env.GIT_STATE }} \ - -X github.com/OpenCHAMI/magellan/internal/version.BuildHost={{ .Env.BUILD_HOST }} \ - -X github.com/OpenCHAMI/magellan/internal/version.GoVersion={{ .Env.GO_VERSION }} \ - -X github.com/OpenCHAMI/magellan/internal/version.BuildUser={{ .Env.BUILD_USER }} " + - "-X github.com/davidallendj/magellan/internal/version.GitCommit={{ .Commit }} \ + -X github.com/davidallendj/magellan/internal/version.BuildTime={{ .Timestamp }} \ + -X github.com/davidallendj/magellan/internal/version.Version={{ .Version }} \ + -X github.com/davidallendj/magellan/internal/version.GitBranch={{ .Branch }} \ + -X github.com/davidallendj/magellan/internal/version.GitTag={{ .Tag }} \ + -X github.com/davidallendj/magellan/internal/version.GitState={{ .Env.GIT_STATE }} \ + -X github.com/davidallendj/magellan/internal/version.BuildHost={{ .Env.BUILD_HOST }} \ + -X github.com/davidallendj/magellan/internal/version.GoVersion={{ .Env.GO_VERSION }} \ + -X github.com/davidallendj/magellan/internal/version.BuildUser={{ .Env.BUILD_USER }} " tags: - version goos: diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e2a189..277e9d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -400,7 +400,7 @@ Tidied up CLI flag names * Ability to update firmware * Refactored connection handling for faster scanning - * Updated to reflect home at github.com/OpenCHAMI + * Updated to reflect home at github.com/davidallendj * Updated to reflect ghcr.io as container home ## [Unreleased] diff --git a/Makefile b/Makefile index 80292d4..a28a664 100644 --- a/Makefile +++ b/Makefile @@ -100,9 +100,9 @@ diff: ## git diff .PHONY: docs docs: ## go docs $(call print-target) - go doc github.com/OpenCHAMI/magellan/cmd - go doc github.com/OpenCHAMI/magellan/internal - go doc github.com/OpenCHAMI/magellan/pkg/crawler + go doc github.com/davidallendj/magellan/cmd + go doc github.com/davidallendj/magellan/internal + go doc github.com/davidallendj/magellan/pkg/crawler .PHONY: emulator emulator: diff --git a/README.md b/README.md index 013b804..81d1d11 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Magellan -The `magellan` CLI tool is a Redfish-based, board management controller (BMC) discovery tool designed to scan networks and is written in Go. The tool collects information from BMC nodes using the provided Redfish RESTful API with [`gofish`](https://github.com/stmcginnis/gofish) and loads the queried data into an [SMD](https://github.com/OpenCHAMI/smd/) instance. The tool strives to be more flexible by implementing multiple methods of discovery to work for a wider range of systems (WIP) and is capable of being used independently of other tools or services. +The `magellan` CLI tool is a Redfish-based, board management controller (BMC) discovery tool designed to scan networks and is written in Go. The tool collects information from BMC nodes using the provided Redfish RESTful API with [`gofish`](https://github.com/stmcginnis/gofish) and loads the queried data into an [SMD](https://github.com/davidallendj/smd/tree/master) instance. The tool strives to be more flexible by implementing multiple methods of discovery to work for a wider range of systems (WIP) and is capable of using independently of other tools or services. > [!NOTE] > The v0.1.0 version of `magellan` is incompatible with `smd` v2.15.3 and earlier due to `smd` lacking the inventory parsing code used with `magellan`'s output.** @@ -383,7 +383,7 @@ The `magellan` tool has a `login` subcommand that works with the [`opaal`](https export ACCESS_TOKEN=eyJhbGciOiJIUzI1NiIs... ``` -Alternatively, if you are running the OpenCHAMI quickstart in the [deployment recipes](https://github.com/OpenCHAMI/deployment-recipes), you can run the provided script to generate a token and set the environment variable that way. +Alternatively, if you are running the OpenCHAMI quickstart in the [deployment recipes](https://github.com/davidallendj/deployment-recipes), you can run the provided script to generate a token and set the environment variable that way. ```bash quickstart_dir=path/to/deployment/recipes/quickstart diff --git a/cmd/collect.go b/cmd/collect.go index e1a2eac..abd3c49 100644 --- a/cmd/collect.go +++ b/cmd/collect.go @@ -3,13 +3,13 @@ package cmd import ( "encoding/json" - "github.com/OpenCHAMI/magellan/internal/cache/sqlite" - urlx "github.com/OpenCHAMI/magellan/internal/url" - magellan "github.com/OpenCHAMI/magellan/pkg" - "github.com/OpenCHAMI/magellan/pkg/auth" - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/secrets" "github.com/cznic/mathutil" + "github.com/davidallendj/magellan/internal/cache/sqlite" + urlx "github.com/davidallendj/magellan/internal/url" + magellan "github.com/davidallendj/magellan/pkg" + "github.com/davidallendj/magellan/pkg/auth" + "github.com/davidallendj/magellan/pkg/bmc" + "github.com/davidallendj/magellan/pkg/secrets" "github.com/rs/zerolog/log" "github.com/spf13/cobra" "github.com/spf13/viper" diff --git a/cmd/crawl.go b/cmd/crawl.go index c9cb55d..875794d 100644 --- a/cmd/crawl.go +++ b/cmd/crawl.go @@ -8,10 +8,10 @@ import ( "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" - urlx "github.com/OpenCHAMI/magellan/internal/url" - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/crawler" - "github.com/OpenCHAMI/magellan/pkg/secrets" + urlx "github.com/davidallendj/magellan/internal/url" + "github.com/davidallendj/magellan/pkg/bmc" + "github.com/davidallendj/magellan/pkg/crawler" + "github.com/davidallendj/magellan/pkg/secrets" "github.com/spf13/cobra" "github.com/spf13/viper" ) diff --git a/cmd/list.go b/cmd/list.go index f833443..e82b4a1 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -7,7 +7,7 @@ import ( "strings" "time" - "github.com/OpenCHAMI/magellan/internal/cache/sqlite" + "github.com/davidallendj/magellan/internal/cache/sqlite" "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" diff --git a/cmd/login.go b/cmd/login.go index 47aec06..5811d9b 100644 --- a/cmd/login.go +++ b/cmd/login.go @@ -6,8 +6,8 @@ import ( "net/http" "os" - magellan "github.com/OpenCHAMI/magellan/internal" - "github.com/OpenCHAMI/magellan/pkg/auth" + magellan "github.com/davidallendj/magellan/internal" + "github.com/davidallendj/magellan/pkg/auth" "github.com/lestrrat-go/jwx/jwt" "github.com/rs/zerolog/log" "github.com/spf13/cobra" diff --git a/cmd/root.go b/cmd/root.go index 3a9e487..360d680 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -19,8 +19,8 @@ import ( "net" "os" - magellan "github.com/OpenCHAMI/magellan/internal" - "github.com/OpenCHAMI/magellan/internal/util" + magellan "github.com/davidallendj/magellan/internal" + "github.com/davidallendj/magellan/internal/util" "github.com/rs/zerolog/log" "github.com/spf13/cobra" "github.com/spf13/viper" diff --git a/cmd/scan.go b/cmd/scan.go index 47846d5..98e5e5a 100644 --- a/cmd/scan.go +++ b/cmd/scan.go @@ -7,13 +7,13 @@ import ( "os" "path" - "github.com/OpenCHAMI/magellan/internal/cache/sqlite" - magellan "github.com/OpenCHAMI/magellan/pkg" + "github.com/davidallendj/magellan/internal/cache/sqlite" + magellan "github.com/davidallendj/magellan/pkg" "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" - urlx "github.com/OpenCHAMI/magellan/internal/url" "github.com/cznic/mathutil" + urlx "github.com/davidallendj/magellan/internal/url" "github.com/spf13/cobra" "github.com/spf13/viper" ) diff --git a/cmd/update.go b/cmd/update.go index f07a0bb..ed9f7c5 100644 --- a/cmd/update.go +++ b/cmd/update.go @@ -4,9 +4,9 @@ import ( "os" "strings" - magellan "github.com/OpenCHAMI/magellan/pkg" - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/secrets" + magellan "github.com/davidallendj/magellan/pkg" + "github.com/davidallendj/magellan/pkg/bmc" + "github.com/davidallendj/magellan/pkg/secrets" "github.com/rs/zerolog/log" "github.com/spf13/cobra" "github.com/spf13/viper" diff --git a/cmd/version.go b/cmd/version.go index 87b7596..921ae81 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -1,7 +1,7 @@ package cmd import ( - "github.com/OpenCHAMI/magellan/internal/version" + "github.com/davidallendj/magellan/internal/version" "github.com/spf13/cobra" ) diff --git a/internal/cache/sqlite/sqlite.go b/internal/cache/sqlite/sqlite.go index 12fc2bb..e3a6bc7 100644 --- a/internal/cache/sqlite/sqlite.go +++ b/internal/cache/sqlite/sqlite.go @@ -4,8 +4,8 @@ import ( "fmt" "strings" - "github.com/OpenCHAMI/magellan/internal/util" - magellan "github.com/OpenCHAMI/magellan/pkg" + "github.com/davidallendj/magellan/internal/util" + magellan "github.com/davidallendj/magellan/pkg" "github.com/jmoiron/sqlx" ) diff --git a/internal/config.go b/internal/config.go index 4059269..ab26dcc 100644 --- a/internal/config.go +++ b/internal/config.go @@ -3,7 +3,7 @@ package magellan import ( "fmt" - "github.com/OpenCHAMI/magellan/internal/util" + "github.com/davidallendj/magellan/internal/util" "github.com/spf13/viper" ) diff --git a/internal/util/bmc.go b/internal/util/bmc.go deleted file mode 100644 index 76f61a8..0000000 --- a/internal/util/bmc.go +++ /dev/null @@ -1,47 +0,0 @@ -package util - -import ( - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/secrets" - "github.com/rs/zerolog/log" -) - -func GetBMCCredentials(store secrets.SecretStore, id string) bmc.BMCCredentials { - var ( - creds bmc.BMCCredentials - err error - ) - - if id == "" { - log.Error().Msg("failed to get BMC credentials: id was empty") - return creds - } - - if id == secrets.DEFAULT_KEY { - log.Info().Msg("fetching default credentials") - if creds, err = bmc.GetBMCCredentialsDefault(store); err != nil { - log.Warn().Err(err).Msg("failed to get default credentials") - } else { - log.Info().Msg("default credentials found, using") - } - return creds - } - - if creds, err = bmc.GetBMCCredentials(store, id); err != nil { - // Specific credentials for URI not found, fetch default. - log.Warn().Str("id", id).Msg("specific credentials not found, falling back to default") - if defaultSecret, err := bmc.GetBMCCredentialsDefault(store); err != nil { - // We've exhausted all options, the credentials will be blank unless - // overridden by a CLI flag. - log.Warn().Str("id", id).Err(err).Msg("no default credentials were set, they will be blank unless overridden by CLI flags") - } else { - // Default credentials found, use them. - log.Info().Str("id", id).Msg("default credentials found, using") - creds = defaultSecret - } - } else { - log.Info().Str("id", id).Msg("specific credentials found, using") - } - - return creds -} diff --git a/internal/version/version.go b/internal/version/version.go index 7d9d231..b7dae64 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -5,40 +5,40 @@ import ( ) // GitCommit stores the latest Git commit hash. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitCommit=$(git rev-parse HEAD)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.GitCommit=$(git rev-parse HEAD)" var GitCommit string // BuildTime stores the build timestamp in UTC. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)" var BuildTime string // Version indicates the version of the binary, such as a release number or semantic version. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.Version=v1.0.0" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.Version=v1.0.0" var Version string // GitBranch holds the name of the Git branch from which the build was created. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitBranch=$(git rev-parse --abbrev-ref HEAD)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.GitBranch=$(git rev-parse --abbrev-ref HEAD)" var GitBranch string // GitTag represents the most recent Git tag at build time, if any. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitTag=$(git describe --tags --abbrev=0)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.GitTag=$(git describe --tags --abbrev=0)" var GitTag string // GitState indicates whether the working directory was "clean" or "dirty" (i.e., with uncommitted changes). -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GitState=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.GitState=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)" var GitState string // BuildHost stores the hostname of the machine where the binary was built. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildHost=$(hostname)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.BuildHost=$(hostname)" var BuildHost string // GoVersion captures the Go version used to build the binary. // Typically, this can be obtained automatically with runtime.Version(), but you can set it manually. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.GoVersion=$(go version | awk '{print $3}')" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.GoVersion=$(go version | awk '{print $3}')" var GoVersion string // BuildUser is the username of the person or system that initiated the build process. -// Set via -ldflags "-X github.com/OpenCHAMI/magellan/internal/version.BuildUser=$(whoami)" +// Set via -ldflags "-X github.com/davidallendj/magellan/internal/version.BuildUser=$(whoami)" var BuildUser string // PrintVersionInfo outputs all versioning information for troubleshooting or version checks. diff --git a/main.go b/main.go index ebe2d95..f0e9e5d 100644 --- a/main.go +++ b/main.go @@ -1,7 +1,7 @@ package main import ( - "github.com/OpenCHAMI/magellan/cmd" + "github.com/davidallendj/magellan/cmd" ) func main() { diff --git a/pkg/bmc/bmc.go b/pkg/bmc/bmc.go index 387100a..90dcadf 100644 --- a/pkg/bmc/bmc.go +++ b/pkg/bmc/bmc.go @@ -4,7 +4,7 @@ import ( "encoding/json" "fmt" - "github.com/OpenCHAMI/magellan/pkg/secrets" + "github.com/davidallendj/magellan/pkg/secrets" ) type BMCCredentials struct { diff --git a/pkg/client/smd.go b/pkg/client/smd.go index 0f2fbb2..5ba49a4 100644 --- a/pkg/client/smd.go +++ b/pkg/client/smd.go @@ -1,8 +1,8 @@ package client // See ref for API docs: -// https://github.com/OpenCHAMI/hms-smd/blob/master/docs/examples.adoc -// https://github.com/OpenCHAMI/hms-smd +// https://github.com/davidallendj/hms-smd/blob/master/docs/examples.adoc +// https://github.com/davidallendj/hms-smd import ( "encoding/json" "fmt" diff --git a/pkg/collect.go b/pkg/collect.go index 2c08db4..0a4bb4e 100644 --- a/pkg/collect.go +++ b/pkg/collect.go @@ -12,11 +12,11 @@ import ( "sync" "time" - "github.com/OpenCHAMI/magellan/internal/util" - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/client" - "github.com/OpenCHAMI/magellan/pkg/crawler" - "github.com/OpenCHAMI/magellan/pkg/secrets" + "github.com/davidallendj/magellan/internal/util" + "github.com/davidallendj/magellan/pkg/bmc" + "github.com/davidallendj/magellan/pkg/client" + "github.com/davidallendj/magellan/pkg/crawler" + "github.com/davidallendj/magellan/pkg/secrets" "gopkg.in/yaml.v3" "github.com/rs/zerolog/log" diff --git a/pkg/crawler/main.go b/pkg/crawler/main.go index 887bf84..64b1d29 100644 --- a/pkg/crawler/main.go +++ b/pkg/crawler/main.go @@ -4,9 +4,9 @@ import ( "fmt" "strings" - "github.com/OpenCHAMI/magellan/internal/util" - "github.com/OpenCHAMI/magellan/pkg/bmc" - "github.com/OpenCHAMI/magellan/pkg/secrets" + "github.com/davidallendj/magellan/internal/util" + "github.com/davidallendj/magellan/pkg/bmc" + "github.com/davidallendj/magellan/pkg/secrets" "github.com/rs/zerolog/log" "github.com/stmcginnis/gofish" "github.com/stmcginnis/gofish/redfish" diff --git a/pkg/scan.go b/pkg/scan.go index 27c0411..dc80aa8 100644 --- a/pkg/scan.go +++ b/pkg/scan.go @@ -11,8 +11,8 @@ import ( "sync" "time" - urlx "github.com/OpenCHAMI/magellan/internal/url" - "github.com/OpenCHAMI/magellan/pkg/client" + urlx "github.com/davidallendj/magellan/internal/url" + "github.com/davidallendj/magellan/pkg/client" "github.com/rs/zerolog/log" ) diff --git a/pkg/secrets/example/main.go b/pkg/secrets/example/main.go index 52ab649..d5739b8 100644 --- a/pkg/secrets/example/main.go +++ b/pkg/secrets/example/main.go @@ -16,7 +16,7 @@ import ( "fmt" "os" - "github.com/OpenCHAMI/magellan/pkg/secrets" + "github.com/davidallendj/magellan/pkg/secrets" ) func usage() { diff --git a/tests/api_test.go b/tests/api_test.go index 999f142..572b941 100644 --- a/tests/api_test.go +++ b/tests/api_test.go @@ -22,9 +22,9 @@ import ( "flag" - "github.com/OpenCHAMI/magellan/internal/util" - magellan "github.com/OpenCHAMI/magellan/pkg" - "github.com/OpenCHAMI/magellan/pkg/client" + "github.com/davidallendj/magellan/internal/util" + magellan "github.com/davidallendj/magellan/pkg" + "github.com/davidallendj/magellan/pkg/client" "github.com/rs/zerolog/log" ) diff --git a/tests/compatibility_test.go b/tests/compatibility_test.go index f428f6a..766b96b 100644 --- a/tests/compatibility_test.go +++ b/tests/compatibility_test.go @@ -14,9 +14,9 @@ import ( "net/http" "testing" - "github.com/OpenCHAMI/magellan/pkg/client" - "github.com/OpenCHAMI/magellan/pkg/crawler" - "github.com/OpenCHAMI/magellan/pkg/secrets" + "github.com/davidallendj/magellan/pkg/client" + "github.com/davidallendj/magellan/pkg/crawler" + "github.com/davidallendj/magellan/pkg/secrets" ) var (