Allow to define EPR and Kibana repository URL in elastic-package configuration file by mrodm · Pull Request #3232 · elastic/elastic-package

mrodm · 2026-01-26T18:57:34Z

Follows #3229
Part of #2993

Includes two new configuration into ~/.elastic-package/config.yml to allow overriding the defaults URLs used by elastic-package.

Example:

stack:
    image_ref_overrides: {}
profile:
    current: default

## New configuration fields
package_registry:
  base_url: "https://epr.elastic.co"
status:
  kibana_repository:
    base_url: "https://raw.githubusercontent.com/elastic/kibana"

This PR keeps the same default values:

Package Registry: https://epr.elastic.co
Kibana URL: https://raw.githubusercontent.com/elastic/kibana

In the case of the package registry, the value from the configuration file will be taken into consideration for the following commands such as:

elastic-package stack up (Serverless and Environment providers)
elastic-package stack update (Docker Compose provider)
elastic-package status
elastic-package test script (stackUp function)

This PR also takes into account the profile setting stack.epr.proxy_to. This configuration, if set, will take precedence to get the value to fill the value for the EPR_PROXY_TO environment variable in the packge-registry Dockerfile.

Author's checklist

Test with custom package-registry and kibana URLs in elastic-package status.
Test with custom package-registry URLs in elastic-package stack (Serverless provider).
Test with custom package-registry URLs in elastic-package stack (Environment provider).
Ensure that elastic-package keeps using the default URLs if they are not specified in the config.
Update documentation

How to test this PR locally

Edit ~/.elastic-package/config.yml including:

package_registry:
  base_url: "https://epr-staging.elastic.co"
status:
  kibana_repository:
    base_url: "https://raw.githubusercontent.com/mrodm/kibana"

Run elastic-package status with different parameters:

# It should use the custom EPR URL
go run github.com/elastic/elastic-package -C test/packages/parallel/nginx status -vv

# It should use the custom EPR URL and the custom Kibana Repository URL
# Delete the cache folder to force query to the Github URL
rm -rf ~/.elastic-package/cache/kibana_config
go run github.com/elastic/elastic-package -C test/packages/parallel/nginx status -vv --info kibana.version,serverless.project_types
# Example output:
# TRACE Sending request to Package Registry API: https://epr-staging.elastic.co/search?all=false&experimental=true&package=nginx&prerelease=true
# TRACE Request Serverless Kibana configuration from https://raw.githubusercontent.com/mrodm/kibana/main/config/serverless.oblt.yml
# TRACE Request Serverless Kibana configuration from https://raw.githubusercontent.com/mrodm/kibana/main/config/serverless.security.yml
# TRACE Request Serverless Kibana configuration from https://raw.githubusercontent.com/mrodm/kibana/main/config/serverless.es.yml
# TRACE Sending request to Package Registry API: https://epr-staging.elastic.co/search?all=false&capabilities=apm&capabilities=observability&capabilities=uptime&experimental=true&package=nginx&prerelease=true
# TRACE Sending request to Package Registry API: https://epr-staging.elastic.co/search?all=false&capabilities=security&experimental=true&package=nginx&prerelease=true
# TRACE Sending request to Package Registry API: https://epr-staging.elastic.co/search?all=false&experimental=true&package=nginx&prerelease=true

Test for instance with environment provider:
- It requires to follow this example

# Once it is started Elasticsearch and Kibana following the previous doc

go run github.com/elastic/elastic-package profiles create environment
go run github.com/elastic/elastic-package profiles use environment

# this command show show that the new EPR URL is being used to get the fleet package
go run github.com/elastic/elastic-package stack up -vv -d --provider environment
# Example output:
# TRACE Sending request to Package Registry API: https://epr-staging.elastic.co/search?all=false&experimental=false&kibana.version=9.2.4&package=fleet_server&prerelease=false
# DEBUG Found fleet_server package - version 1.6.0


go run github.com/elastic/elastic-package stack down -v

…om-urls

mrodm · 2026-01-27T10:52:48Z

Missing to add a new profile setting stack.epr.base_url to be able to override the package registry URL used in those commands using profile (e.g. elastic-package stack)

teresaromero · 2026-01-28T08:50:57Z

tools/readme/readme.md.tmpl

+profile:
+    current: default
+schema_urls:
+  ecs_base:  https://raw.githubusercontent.com/elastic/ecs


nit: just thinking now, should this be ecs_base_url ??

I think it would not be needed since this field is under the key schema_urls that already refers to URLs.

teresaromero · 2026-01-28T08:55:14Z

internal/stack/environment.go

 	}
 	p.elasticsearch = elasticsearch

+	p.registry = registry.NewClient(appConfig.PackageRegistryBaseURL())


could we benefit of passing just the url as a string? instead of the struct for appConfig, given that we only need one of its params

teresaromero · 2026-01-28T09:02:52Z

internal/stack/options.go

-	Profile *profile.Profile
-	Printer Printer
+	Profile   *profile.Profile
+	AppConfig *install.ApplicationConfiguration


currently we use this AppConfig to provide the registryURL, could we just pass along the string url, and change it into a struct if we need future options?

This value could depend on the specific use case.
For instance, for stack commands the registry URL value will depend on where it is used:

To write the value of EPR_PROXY_TO variable, this value depends on the stack.epr.proxy_to setting from the profile or the value in the configuration file.

However other usages in stack commands will depend on another profile setting stack.epr.base_url and the value in the configuration file. This will be required when doing elastic-package stack up in Serverless or Environment providers.

This last scenario described can be observed in the changes applied in #3235

So, maybe we need to keep both the profile and the configuration.

jsoriano

Looks good, thanks, added some small suggestions.

jsoriano · 2026-01-28T20:15:16Z

cmd/status.go

 }

-func getPackageStatus(packageName string, options registry.SearchOptions) (*status.PackageStatus, error) {
+func getPackageStatus(packageName string, options registry.SearchOptions, registryClient *registry.Client) (*status.PackageStatus, error) {


Nit. I would place the client as first parameter, here and in the other methods where this is added.

Suggested change

func getPackageStatus(packageName string, options registry.SearchOptions, registryClient *registry.Client) (*status.PackageStatus, error) {

func getPackageStatus(registryClient *registry.Client, packageName string, options registry.SearchOptions) (*status.PackageStatus, error) {

Sure! I've applied these changes in 9108ad8

internal/install/application_configuration.go

jsoriano · 2026-01-28T20:20:07Z

internal/install/application_configuration.go

+	if ac == nil {
+		return "https://raw.githubusercontent.com/elastic/kibana"
+	}
+	if ac.c.Status.KibanaRepository.BaseURL != "" {
+		return ac.c.Status.KibanaRepository.BaseURL
+	}
+	return defaultKibanaRepositoryBaseURL


Or:

Suggested change

if ac == nil {

return "https://raw.githubusercontent.com/elastic/kibana"

}

if ac.c.Status.KibanaRepository.BaseURL != "" {

return ac.c.Status.KibanaRepository.BaseURL

}

return defaultKibanaRepositoryBaseURL

if ac == nil || ac.c.Status.KibanaRepository.BaseURL == "" {

return defaultKibanaRepositoryBaseURL

}

return ac.c.Status.KibanaRepository.BaseURL

Applied these changes here 112327b

jsoriano · 2026-01-28T20:34:04Z

internal/install/application_configuration_test.go

+				require.NoError(t, err)
+			}
+
+			config, err := Configuration()


Perhaps we could have a method that initializes the configuration from a given directory, so we don't need to set ELASTIC_PACKAGE_DATA_HOME.

Suggested change

config, err := Configuration()

config, err := configurationFromDir(tmpDir)

Added change for this test 61bb121

elasticmachine · 2026-01-29T09:35:21Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 61bb121

Failed CI Steps

:windows: Run stack tests

History

💛 Build #7064 was flaky 5aa3c5a
💚 Build #7060 succeeded 7faea12

cc @mrodm

mrodm added 12 commits January 22, 2026 16:26

Add custom package-registry URL for status

f58a910

Add custom kibana URL for status

800cb9a

Use production URL from registry package

7f61f91

Rename functions

b141bae

Add documentation

62535cd

Add a status parent field for package-registry and kibana

a9ca9ee

Add tests

f5a03da

Add constant for kibana URL

2b04042

Update application configuration test

6408936

Merge remote-tracking branch 'upstream/main' into status-command-cust…

3ab5d98

…om-urls

Add support to use epr defined in elastic-package config in commands

6a1026c

Delete public var for Production EPR

0ce95c4

mrodm self-assigned this Jan 26, 2026

mrodm added 3 commits January 27, 2026 09:48

Update location for package_registry setting

38487e3

Update documentation

9035ba0

Rename method

c5e4bf2

mrodm mentioned this pull request Jan 27, 2026

Allow to use custom URLs in elastic-package status #3229

Closed

3 tasks

Update documentation

7faea12

mrodm marked this pull request as ready for review January 27, 2026 10:52

mrodm requested a review from a team January 27, 2026 10:53

Update test script command

0ab58f2

mrodm mentioned this pull request Jan 27, 2026

Add new stack.epr.base_url profile setting #3235

Merged

6 tasks

Re-order imports

5aa3c5a

teresaromero reviewed Jan 28, 2026

View reviewed changes

teresaromero approved these changes Jan 28, 2026

View reviewed changes

jsoriano approved these changes Jan 28, 2026

View reviewed changes

Re-order registry client parameter

9108ad8

mrodm added 2 commits January 29, 2026 10:06

Refactor application configuration getter methods

112327b

Add method to read configuration from a specific directory

61bb121

mrodm merged commit f9bca8d into elastic:main Jan 29, 2026
3 checks passed

mrodm deleted the command-custom-epr-kibana-urls-config branch January 29, 2026 10:00

jsoriano mentioned this pull request Jan 28, 2026

Allow to use custom URLs to retrieve ECS schemas #3220

Merged

7 tasks

jsoriano mentioned this pull request Feb 11, 2026

internal/testrunner/script: add breaking change conditionals #3263

Merged

	func getPackageStatus(packageName string, options registry.SearchOptions, registryClient registry.Client) (status.PackageStatus, error) {
	func getPackageStatus(registryClient registry.Client, packageName string, options registry.SearchOptions) (status.PackageStatus, error) {

	config, err := Configuration()
	config, err := configurationFromDir(tmpDir)

Conversation

mrodm commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Author's checklist

How to test this PR locally

Uh oh!

mrodm commented Jan 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsoriano left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💛 Build succeeded, but was flaky

Failed CI Steps

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mrodm commented Jan 26, 2026 •

edited

Loading

elasticmachine commented Jan 29, 2026 •

edited

Loading