Skip to content

use urls from zos-config if exists #33

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.

Sign up for GitHub

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

Merged
Eslam-Nawara merged 20 commits into from
Jul 31, 2025
Merged

use urls from zos-config if exists #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
667bbe2
use urls from zos-config if exists
Eslam-Nawara Jun 10, 2025
cf49efc
fix check urls length
Eslam-Nawara Jun 11, 2025
2bade3b
update not working domains to the new domains in zosbase
Eslam-Nawara Jun 16, 2025
0a89f06
load huburl from zos-conf
Eslam-Nawara Jun 16, 2025
35c21b4
update hub storage
Eslam-Nawara Jun 16, 2025
f20708e
fix typos in getting config from zos-config
ashraffouda Jun 17, 2025
239cdf7
fixing huburl
ashraffouda Jun 18, 2025
f493ae2
add hub storage and geoip to config and env
Eslam-Nawara Jun 18, 2025
88c17d2
add v4hub url to env
Eslam-Nawara Jun 18, 2025
056f9b8
update registrar to load env every time it trys to register
Eslam-Nawara Jun 18, 2025
82870df
update hub to hub.grid.tf again
Eslam-Nawara Jun 22, 2025
87e059f
rename default urls
Eslam-Nawara Jun 22, 2025
67517d3
stop listening changes in storage and flist Changes
Eslam-Nawara Jul 7, 2025
0cce6e8
Merge branch 'main' into load-config-urls-from-zos-config
Eslam-Nawara Jul 23, 2025
4c22507
use []hub urls instead of one url
Eslam-Nawara Jul 23, 2025
69773c0
log retry error in perf tests with Debug level
Eslam-Nawara Jul 23, 2025
0168ec5
fix lint
Eslam-Nawara Jul 23, 2025
40a932c
fix typo
Eslam-Nawara Jul 27, 2025
222da99
update failed to ping node to warn log level
Eslam-Nawara Jul 30, 2025
609137e
support configuring flist/storage urls from zos-config
Eslam-Nawara Jul 30, 2025
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
16 changes: 12 additions & 4 deletions pkg/environment/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,23 @@ type Config struct {
RolloutUpgrade struct {
TestFarms []uint32 `json:"test_farms"`
} `json:"rollout_upgrade"`
RelaysURLs []string `json:"relays_urls"`
SubstrateURL []string `json:"substrate_urls"`
RelaysURLs []string `json:"relays_urls"`
ActivationURL []string `json:"activation_urls"`
GraphQL []string `json:"graphql_urls"`
KycURL string `json:"kyc_url"`
RegistrarURL string `json:"registrar_url"`
// FlistURL []string `json:"flist_url"`
// HubURL []string `json:"hub_url"`
BinRepo string `json:"bin_repo"`
BinRepo string `json:"bin_repo"`
GeoipURLs []string `json:"geoip_urls"`

HubURL []string `json:"hub_url"`
V4HubURL []string `json:"v4_hub_url"`

// we should not be supporting flist url or hub storage from zos-config until we can update them on runtime
FlistURL string `json:"flist_url"`
V4FlistURL string `json:"v4_flist_url"`
HubStorage string `json:"hub_storage"`
V4HubStorage string `json:"v4_hub_storage"`
}

// Merge, updates current config with cfg merging and override config
Expand Down
138 changes: 93 additions & 45 deletions pkg/environment/environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,24 @@ import (

const (
baseExtendedURL = "https://raw.githubusercontent.com/threefoldtech/zos-config/main/"
hubURL = "https://hub.threefold.me"
v4HubURL = "https://v4.hub.threefold.me"
flistURL = "redis://hub.threefold.me:9900"
v4FlistURL = "redis://v4.hub.threefold.me:9940"

defaultHubURL = "https://hub.threefold.me"
defaultV4HubURL = "https://v4.hub.threefold.me"

defaultFlistURL = "redis://hub.threefold.me:9900"
defaultV4FlistURL = "redis://v4.hub.threefold.me:9940"

defaultHubStorage = "zdb://hub.threefold.me:9900"
defaultV4HubStorage = "zdb://v4.hub.threefold.me:9940"
)

var defaultGeoipURLs = []string{
"https://geoip.threefold.me/",
"https://geoip.grid.tf/",
"https://02.geoip.grid.tf/",
"https://03.geoip.grid.tf/",
}

// PubMac specify how the mac address of the public nic
// (in case of public-config) is calculated
type PubMac string
Expand All @@ -42,8 +54,12 @@ const (
type Environment struct {
RunningMode RunMode

FlistURL string
BinRepo string
FlistURL string
HubStorage string
BinRepo string

HubURL string
V4HubURL string

FarmID pkg.FarmID
Orphan bool
Expand All @@ -56,9 +72,9 @@ type Environment struct {
relaysURLs []string
ActivationURL []string
GraphQL []string
GeoipURLs []string
KycURL string
RegistrarURL string
HubURL string

// private vlan to join
// if set, zos will use this as its priv vlan
Expand Down Expand Up @@ -126,15 +142,18 @@ var (
"https://activation.dev.grid.tf/activation/activate",
"https://activation.02.dev.grid.tf/activation/activate",
},
FlistURL: flistURL,
HubURL: hubURL,
BinRepo: "tf-zos-v3-bins.dev",
HubURL: defaultHubURL,
V4HubURL: defaultV4HubURL,
FlistURL: defaultFlistURL,
HubStorage: defaultHubStorage,
BinRepo: "tf-zos-v3-bins.dev",
GraphQL: []string{
"https://graphql.dev.grid.tf/graphql",
"https://graphql.02.dev.grid.tf/graphql",
},
KycURL: "https://kyc.dev.grid.tf",
RegistrarURL: "http://registrar.dev4.grid.tf",
GeoipURLs: defaultGeoipURLs,
}

envTest = Environment{
Expand All @@ -150,15 +169,18 @@ var (
"https://activation.test.grid.tf/activation/activate",
"https://activation.02.test.grid.tf/activation/activate",
},
FlistURL: flistURL,
HubURL: hubURL,
BinRepo: "tf-zos-v3-bins.test",
HubURL: defaultHubURL,
V4HubURL: defaultV4HubURL,
FlistURL: defaultFlistURL,
HubStorage: defaultHubStorage,
BinRepo: "tf-zos-v3-bins.test",
GraphQL: []string{
"https://graphql.test.grid.tf/graphql",
"https://graphql.02.test.grid.tf/graphql",
},
KycURL: "https://kyc.test.grid.tf",
RegistrarURL: "http://registrar.test4.grid.tf",
GeoipURLs: defaultGeoipURLs,
}

envQA = Environment{
Expand All @@ -174,15 +196,18 @@ var (
"https://activation.qa.grid.tf/activation/activate",
"https://activation.02.qa.grid.tf/activation/activate",
},
FlistURL: flistURL,
HubURL: hubURL,
BinRepo: "tf-zos-v3-bins.qanet",
HubURL: defaultHubURL,
V4HubURL: defaultV4HubURL,
FlistURL: defaultFlistURL,
HubStorage: defaultHubStorage,
BinRepo: "tf-zos-v3-bins.qanet",
GraphQL: []string{
"https://graphql.qa.grid.tf/graphql",
"https://graphql.02.qa.grid.tf/graphql",
},
KycURL: "https://kyc.qa.grid.tf",
RegistrarURL: "https://registrar.qa4.grid.tf",
GeoipURLs: defaultGeoipURLs,
}

envProd = Environment{
Expand All @@ -201,17 +226,22 @@ var (
"https://activation.grid.threefold.me/activation/activate",
"https://activation.grid.tf/activation/activate",
"https://activation.02.grid.tf/activation/activate",
"https://activation.grid.threefold.me/activation/activate",
},
HubURL: hubURL,
FlistURL: flistURL,
BinRepo: "tf-zos-v3-bins",
HubURL: defaultHubURL,
V4HubURL: defaultV4HubURL,
FlistURL: defaultFlistURL,
HubStorage: defaultHubStorage,
BinRepo: "tf-zos-v3-bins",
GraphQL: []string{
"https://graphql.grid.threefold.me/graphql",
"https://graphql.grid.tf/graphql",
"https://graphql.02.grid.tf/graphql",
"https://graphql.grid.threefold.me/graphql",
},
KycURL: "https://kyc.threefold.me",
RegistrarURL: "https://registrar.prod4.threefold.me",
GeoipURLs: defaultGeoipURLs,
}
)

Expand Down Expand Up @@ -295,29 +325,24 @@ func getEnvironmentFromParams(params kernel.Params) (Environment, error) {
if err != nil {
// maybe the node can't reach the internet right now
// this will enforce node to skip config
// or we can keep retrying untill it can fetch config
config = Config{}
}

if substrate, ok := params.Get("substrate"); ok {
if len(substrate) > 0 {
env.SubstrateURL = substrate
}
if substrate, ok := params.Get("substrate"); ok && len(substrate) > 0 {
env.SubstrateURL = substrate
} else if substrate := config.SubstrateURL; len(substrate) > 0 {
env.SubstrateURL = substrate
}

if relay, ok := params.Get("relay"); ok {
if len(relay) > 0 {
env.relaysURLs = relay
}
if relay, ok := params.Get("relay"); ok && len(relay) > 0 {
env.relaysURLs = relay
} else if relay := config.RelaysURLs; len(relay) > 0 {
env.relaysURLs = relay
}

if activation, ok := params.Get("activation"); ok {
if len(activation) > 0 {
env.ActivationURL = activation
}
if activation, ok := params.Get("activation"); ok && len(activation) > 0 {
env.ActivationURL = activation
} else if activation := config.ActivationURL; len(activation) > 0 {
env.ActivationURL = activation
}
Expand All @@ -326,14 +351,6 @@ func getEnvironmentFromParams(params kernel.Params) (Environment, error) {
env.GraphQL = graphql
}

// if flist := config.FlistURL; len(flist) > 0 {
// env.FlistURL = flist[0]
// }

// if hub := config.HubURL; len(hub) > 0 {
// env.HubURL = hub[0]
// }

if bin := config.BinRepo; len(bin) > 0 {
env.BinRepo = bin
}
Expand All @@ -346,6 +363,43 @@ func getEnvironmentFromParams(params kernel.Params) (Environment, error) {
env.RegistrarURL = registrar
}

if geoip := config.GeoipURLs; len(geoip) > 0 {
env.GeoipURLs = geoip
}

// flist url and hub storage urls shouldn't listen to changes in config as long as we can't change it at run time.
Copy link
Collaborator

@ashraffouda ashraffouda Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, but if we faced samething when all *.tf were blocked then we will not be able to boot new machines and all those configurable urls will not help unless we can connect to the new storage url

// it would cause breakage in vmd that needs a reboot to be recovered.
if flist := config.FlistURL; len(flist) > 0 {
env.FlistURL = flist
}

if storage := config.HubStorage; len(storage) > 0 {
env.HubStorage = storage
}

// maybe we should verify that we're using a working hub url
if hub := config.HubURL; len(hub) > 0 {
env.HubURL = hub[0]
}

// some modules needs v3 hub url even if the node is of v4
if hub := config.V4HubURL; len(hub) > 0 {
env.V4HubURL = hub[0]
}

// if the node running v4 chage urls to use v4 hub
if params.IsV4() {
env.FlistURL = defaultV4FlistURL
if flist := config.V4FlistURL; len(flist) > 0 {
env.FlistURL = flist
}

env.HubStorage = defaultV4HubStorage
if storage := config.V4HubStorage; len(storage) > 0 {
env.HubStorage = storage
}
}

if farmSecret, ok := params.Get("secret"); ok {
if len(farmSecret) > 0 {
env.FarmSecret = farmSecret[len(farmSecret)-1]
Expand Down Expand Up @@ -423,11 +477,5 @@ func getEnvironmentFromParams(params kernel.Params) (Environment, error) {
env.BinRepo = e
}

// if the node running v4 chage flisturl to use v4.hub.threefold.me
if params.IsV4() {
env.FlistURL = v4FlistURL
env.HubURL = v4HubURL
}

return env, nil
}
10 changes: 4 additions & 6 deletions pkg/geoip/geoip.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/hashicorp/go-retryablehttp"
"github.com/rs/zerolog/log"
"github.com/threefoldtech/zosbase/pkg/environment"
)

// Location holds the result of a geoip request
Expand All @@ -19,15 +20,12 @@ type Location struct {
City string `json:"city_name"`
}

var (
geoipURLs = []string{"https://geoip.threefold.me/", "https://geoip.grid.tf/", "https://02.geoip.grid.tf/", "https://03.geoip.grid.tf/"}

defaultHTTPClient = retryablehttp.NewClient()
)
var defaultHTTPClient = retryablehttp.NewClient()

// Fetch retrieves the location of the system calling this function
func Fetch() (Location, error) {
for _, url := range geoipURLs {
env := environment.MustGet()
for _, url := range env.GeoipURLs {
l, err := getLocation(url)
if err != nil {
log.Err(err).Str("url", url).Msg("failed to fetch location from geoip service")
Expand Down
10 changes: 7 additions & 3 deletions pkg/geoip/geoip_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (

"github.com/jarcoal/httpmock"
"github.com/stretchr/testify/require"
"github.com/threefoldtech/zosbase/pkg/environment"
)

func TestGetLocation(t *testing.T) {
Expand All @@ -21,7 +22,8 @@ func TestGetLocation(t *testing.T) {
City: "Cairo",
}

for _, url := range geoipURLs {
env := environment.MustGet()
for _, url := range env.GeoipURLs {
httpmock.RegisterResponder("GET", url,
func(req *http.Request) (*http.Response, error) {
return httpmock.NewJsonResponse(200, l)
Expand All @@ -41,7 +43,8 @@ func TestGetLocation(t *testing.T) {
}

t.Run("test 404 status code", func(t *testing.T) {
for _, url := range geoipURLs {
env := environment.MustGet()
for _, url := range env.GeoipURLs {
httpmock.RegisterResponder("GET", url,
func(req *http.Request) (*http.Response, error) {
return httpmock.NewJsonResponse(404, l)
Expand All @@ -55,7 +58,8 @@ func TestGetLocation(t *testing.T) {
})

t.Run("test invalid response data", func(t *testing.T) {
for _, url := range geoipURLs {
env := environment.MustGet()
for _, url := range env.GeoipURLs {
httpmock.RegisterResponder("GET", url,
func(req *http.Request) (*http.Response, error) {
resp, err := httpmock.NewJsonResponse(200, "Cairo")
Expand Down
Loading
Loading