Use gophercloud endpoint locator (#24)

Author: PhilippMatthes

cortex.secrets.example.yaml

@@ -36,7 +36,3 @@ conf:
         projectName: openstack-project-of-user
         userDomainName: openstack-domain-of-user
         projectDomainName: openstack-domain-of-project-scoped-to
-      nova:
-        url: https://path-to-nova/v2.1
-      placement:
-        url: https://path-to-placement

helm/cortex/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.0
+version: 0.3.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

helm/cortex/values.yaml

@@ -157,17 +157,15 @@ conf:
         userDomainName: openstack-domain-of-user
         projectDomainName: openstack-domain-of-project-scoped-to
       nova:
-        # Compute service URL for openstack.
-        url: https://path-to-nova/v2.1
-
+        # One of admin, public, or internal
+        availability: public
         # Nova objects to sync into the database.
         types:
           - hypervisors
           - servers
       placement:
-        # Placement service URL for openstack.
-        url: https://path-to-placement
-
+        # One of admin, public, or internal
+        availability: public
         # Placement objects to sync into the database.
         types:
           # - resource_providers

internal/conf/validation.go

@@ -103,12 +103,24 @@ func (c *config) Validate() error {
 	// OpenStack urls should end without a slash.
 	for _, url := range []string{
 		c.SyncConfig.OpenStack.Keystone.URL,
-		c.SyncConfig.OpenStack.Nova.URL,
-		c.SyncConfig.OpenStack.Placement.URL,
 	} {
 		if strings.HasSuffix(url, "/") {
 			return fmt.Errorf("openstack url %s should not end with a slash", url)
 		}
 	}
+	// Check that the service availability is valid.
+	validAvailabilities := []string{"public", "internal", "admin"}
+	if c.SyncConfig.OpenStack.Nova.Availability == "" {
+		c.SyncConfig.OpenStack.Nova.Availability = "public"
+	}
+	if c.SyncConfig.OpenStack.Placement.Availability == "" {
+		c.SyncConfig.OpenStack.Placement.Availability = "public"
+	}
+	if !slices.Contains(validAvailabilities, c.SyncConfig.OpenStack.Nova.Availability) {
+		return fmt.Errorf("invalid nova availability %s", c.SyncConfig.OpenStack.Nova.Availability)
+	}
+	if !slices.Contains(validAvailabilities, c.SyncConfig.OpenStack.Placement.Availability) {
+		return fmt.Errorf("invalid placement availability %s", c.SyncConfig.OpenStack.Placement.Availability)
+	}
 	return nil
 }

internal/conf/validation_test.go

@@ -84,3 +84,16 @@ sync:
 		t.Fatalf("expected error, got nil")
 	}
 }
+
+func TestInvalidConf_InvalidServiceAvailability(t *testing.T) {
+	content := `
+sync:
+  openstack:
+    placement:
+      availability: whatever
+`
+	conf := newConfigFromBytes([]byte(content))
+	if err := conf.Validate(); err == nil {
+		t.Fatalf("expected error, got nil")
+	}
+}

internal/conf/yaml.go

@@ -90,16 +90,16 @@ type SyncOpenStackKeystoneConfig struct {
 
 // Configuration for the nova service.
 type SyncOpenStackNovaConfig struct {
-	// The URL of the nova service.
-	URL string `yaml:"url"`
+	// Availability of the service, such as "public", "internal", or "admin".
+	Availability string `yaml:"availability"`
 	// The types of resources to sync.
 	Types []string `yaml:"types"`
 }
 
 // Configuration for the placement service.
 type SyncOpenStackPlacementConfig struct {
-	// The URL of the placement service.
-	URL string `yaml:"url"`
+	// Availability of the service, such as "public", "internal", or "admin".
+	Availability string `yaml:"availability"`
 	// The types of resources to sync.
 	Types []string `yaml:"types"`
 }

internal/sync/openstack/keystone.go

@@ -16,20 +16,30 @@ import (
 // Type alias for the OpenStack keystone configuration.
 type KeystoneConf = conf.SyncOpenStackKeystoneConfig
 
+// KeystoneAPI for OpenStack.
 type KeystoneAPI interface {
+	// Authenticate against the OpenStack keystone.
 	Authenticate(context.Context) error
+	// Get the OpenStack provider client.
 	Client() *gophercloud.ProviderClient
+	// Find the endpoint for the given service type and availability.
+	FindEndpoint(availability, serviceType string) (string, error)
 }
 
+// KeystoneAPI implementation.
 type keystoneAPI struct {
-	client       *gophercloud.ProviderClient
+	// OpenStack provider client.
+	client *gophercloud.ProviderClient
+	// OpenStack keystone configuration.
 	keystoneConf KeystoneConf
 }
 
+// Create a new OpenStack keystone API.
 func newKeystoneAPI(keystoneConf KeystoneConf) KeystoneAPI {
 	return &keystoneAPI{keystoneConf: keystoneConf}
 }
 
+// Authenticate against OpenStack keystone.
 func (api *keystoneAPI) Authenticate(ctx context.Context) error {
 	if api.client != nil {
 		// Already authenticated.
@@ -64,6 +74,15 @@ func (api *keystoneAPI) Authenticate(ctx context.Context) error {
 	return nil
 }
 
+// Find the endpoint for the given service type and availability.
+func (api *keystoneAPI) FindEndpoint(availability, serviceType string) (string, error) {
+	return api.client.EndpointLocator(gophercloud.EndpointOpts{
+		Type:         serviceType,
+		Availability: gophercloud.Availability(availability),
+	})
+}
+
+// Get the OpenStack provider client.
 func (api *keystoneAPI) Client() *gophercloud.ProviderClient {
 	return api.client
 }

internal/sync/openstack/keystone_test.go

@@ -12,7 +12,9 @@ import (
 	"github.com/gophercloud/gophercloud/v2"
 )
 
-type mockKeystoneAPI struct{}
+type mockKeystoneAPI struct {
+	url string
+}
 
 func (m *mockKeystoneAPI) Authenticate(ctx context.Context) error {
 	return nil
@@ -22,6 +24,10 @@ func (m *mockKeystoneAPI) Client() *gophercloud.ProviderClient {
 	return &gophercloud.ProviderClient{}
 }
 
+func (m *mockKeystoneAPI) FindEndpoint(availability, serviceType string) (string, error) {
+	return m.url, nil
+}
+
 //nolint:gocritic
 func setupKeystoneMockServer(handler http.HandlerFunc) (*httptest.Server, KeystoneConf) {
 	server := httptest.NewServer(handler)

internal/sync/openstack/nova_api.go

@@ -46,11 +46,18 @@ func (api *novaAPI) Init(ctx context.Context) {
 	if err := api.keystoneAPI.Authenticate(ctx); err != nil {
 		panic(err)
 	}
+	// Automatically fetch the nova endpoint from the keystone service catalog.
+	provider := api.keystoneAPI.Client()
+	serviceType := "compute"
+	url, err := api.keystoneAPI.FindEndpoint(api.conf.Availability, serviceType)
+	if err != nil {
+		panic(err)
+	}
+	slog.Info("using nova endpoint", "url", url)
 	api.sc = &gophercloud.ServiceClient{
-		ProviderClient: api.keystoneAPI.Client(),
-		// For some reason gophercloud expects a trailing slash.
-		Endpoint: api.conf.URL + "/",
-		Type:     "compute",
+		ProviderClient: provider,
+		Endpoint:       url,
+		Type:           serviceType,
 	}
 }
 

internal/sync/openstack/nova_api_test.go

@@ -15,13 +15,13 @@ import (
 
 func setupNovaMockServer(handler http.HandlerFunc) (*httptest.Server, KeystoneAPI) {
 	server := httptest.NewServer(handler)
-	return server, &mockKeystoneAPI{}
+	return server, &mockKeystoneAPI{url: server.URL + "/"}
 }
 
 func TestNewNovaAPI(t *testing.T) {
 	mon := sync.Monitor{}
 	k := &mockKeystoneAPI{}
-	conf := NovaConf{URL: "http://example.com"}
+	conf := NovaConf{}
 
 	api := newNovaAPI(mon, k, conf)
 	if api == nil {
@@ -44,7 +44,7 @@ func TestNovaAPI_GetAllServers(t *testing.T) {
 	defer server.Close()
 
 	mon := sync.Monitor{}
-	conf := NovaConf{URL: server.URL}
+	conf := NovaConf{Availability: "public"}
 
 	api := newNovaAPI(mon, k, conf).(*novaAPI)
 	api.Init(t.Context())
@@ -76,7 +76,7 @@ func TestNovaAPI_GetAllHypervisors(t *testing.T) {
 	defer server.Close()
 
 	mon := sync.Monitor{}
-	conf := NovaConf{URL: server.URL}
+	conf := NovaConf{Availability: "public"}
 
 	api := newNovaAPI(mon, k, conf).(*novaAPI)
 	api.Init(t.Context())

internal/sync/openstack/placement_api.go

@@ -49,11 +49,18 @@ func (api *placementAPI) Init(ctx context.Context) {
 	if err := api.keystoneAPI.Authenticate(ctx); err != nil {
 		panic(err)
 	}
+	// Automatically fetch the placement endpoint from the keystone service catalog.
+	provider := api.keystoneAPI.Client()
+	serviceType := "placement"
+	url, err := api.keystoneAPI.FindEndpoint(api.conf.Availability, serviceType)
+	if err != nil {
+		panic(err)
+	}
+	slog.Info("using placement endpoint", "url", url)
 	api.sc = &gophercloud.ServiceClient{
-		ProviderClient: api.keystoneAPI.Client(),
-		// For some reason gophercloud expects a trailing slash.
-		Endpoint: api.conf.URL + "/",
-		Type:     "placement",
+		ProviderClient: provider,
+		Endpoint:       url,
+		Type:           serviceType,
 		// Needed, otherwise openstack will return 404s for traits.
 		Microversion: "1.29",
 	}

internal/sync/openstack/placement_api_test.go

@@ -14,13 +14,13 @@ import (
 
 func setupPlacementMockServer(handler http.HandlerFunc) (*httptest.Server, KeystoneAPI) {
 	server := httptest.NewServer(handler)
-	return server, &mockKeystoneAPI{}
+	return server, &mockKeystoneAPI{url: server.URL + "/"}
 }
 
 func TestNewPlacementAPI(t *testing.T) {
 	mon := sync.Monitor{}
 	k := &mockKeystoneAPI{}
-	conf := PlacementConf{URL: "http://example.com"}
+	conf := PlacementConf{}
 
 	api := NewPlacementAPI(mon, k, conf)
 	if api == nil {
@@ -40,7 +40,7 @@ func TestPlacementAPI_GetAllResourceProviders(t *testing.T) {
 	defer server.Close()
 
 	mon := sync.Monitor{}
-	conf := PlacementConf{URL: server.URL}
+	conf := PlacementConf{}
 
 	api := NewPlacementAPI(mon, k, conf).(*placementAPI)
 	api.Init(t.Context())
@@ -70,7 +70,7 @@ func TestPlacementAPI_GetAllTraits(t *testing.T) {
 	defer server.Close()
 
 	mon := sync.Monitor{}
-	conf := PlacementConf{URL: server.URL}
+	conf := PlacementConf{}
 
 	api := NewPlacementAPI(mon, pc, conf).(*placementAPI)
 	api.Init(t.Context())
@@ -101,7 +101,7 @@ func TestPlacementAPI_GetAllTraits_Error(t *testing.T) {
 	defer server.Close()
 
 	mon := sync.Monitor{}
-	conf := PlacementConf{URL: server.URL}
+	conf := PlacementConf{}
 
 	api := NewPlacementAPI(mon, pc, conf).(*placementAPI)
 	api.Init(t.Context())