Skip to content

✨ clusterctl: clearer diagnostics when provider metadata is missing or repo URL is stale #12238

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −2
Open

✨ clusterctl: clearer diagnostics when provider metadata is missing or repo URL is stale #12238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d73498
✨ clusterctl: clearer error messages when provider metadata is missin…
kahirokunn May 19, 2025
2d11fe9
Update cmd/clusterctl/client/cluster/installer.go
kahirokunn May 21, 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
28 changes: 26 additions & 2 deletions cmd/clusterctl/client/cluster/installer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package cluster

import (
"context"
"fmt"
"sort"
"strings"
"time"
Expand Down Expand Up @@ -307,9 +308,16 @@ func (i *providerInstaller) getProviderContract(ctx context.Context, providerIns
return "", err
}

// Fetch metadata for the requested provider version.
// If we hit a 404 or similar error (e.g., the repository moved or the tag
// lacks metadata), wrap the error with additional context so users can
// quickly pinpoint the root cause.
latestMetadata, err := providerRepository.Metadata(provider.Version).Get(ctx)
if err != nil {
return "", err
return "", errors.Wrapf(err,
"failed to fetch metadata for provider %q (version %s). "+
"Check that the release tag exists and the repository URL is correct — the project may have moved or the tag may be missing metadata.yaml",
provider.ManifestLabel(), provider.Version)
}

// Gets the contract for the current release.
Expand All @@ -320,7 +328,23 @@ func (i *providerInstaller) getProviderContract(ctx context.Context, providerIns

releaseSeries := latestMetadata.GetReleaseSeriesForVersion(currentVersion)
if releaseSeries == nil {
return "", errors.Errorf("invalid provider metadata: version %s for the provider %s does not match any release series", provider.Version, provider.InstanceName())
availableSeries := make([]string, 0, len(latestMetadata.ReleaseSeries))
for _, series := range latestMetadata.ReleaseSeries {
availableSeries = append(availableSeries, fmt.Sprintf("%d.%d", series.Major, series.Minor))
}

var errorMsg string
if len(availableSeries) > 0 {
errorMsg = fmt.Sprintf("invalid provider metadata: version %s for the provider %s does not match any release series. "+
"Available series: [%s]. This usually means the release tag lacks an updated metadata.yaml or the repository URL is stale.",
provider.Version, provider.InstanceName(), strings.Join(availableSeries, ", "))
} else {
errorMsg = fmt.Sprintf("invalid provider metadata: version %s for the provider %s does not match any release series. No release series found in metadata. "+
"The metadata.yaml file may be missing or the provider repository may be incorrect.",
provider.Version, provider.InstanceName())
}

return "", errors.New(errorMsg)
}

compatibleContracts := i.getCompatibleContractVersions(i.currentContractVersion)
Expand Down
Loading