-
Notifications
You must be signed in to change notification settings - Fork 197
[ECK 3.3] - Elastic Package Registry release documentation #4670
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.
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
naemono
wants to merge
9
commits into
elastic:eck-3.3.0
Choose a base branch
from
naemono:eck-3.3-epr-release-docs
base: eck-3.3.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+104
−1
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
9f42236
wip
naemono 565dbfb
Add ECK PackageRegistry documentation for 3.3 release.
naemono 09d7595
review updates.
naemono b487453
Fix apiVersion
naemono 51d6ba2
Remove duplicative section.
naemono 53d5826
wording changes from review
naemono 7502d74
Add eck notes to 2 other sections.
naemono f48c782
Updates from review comments
naemono 7dfa5a3
review updates
naemono File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| navigation_title: Elastic Package Registry | ||
| applies_to: | ||
| deployment: | ||
| eck: ga 3.3 | ||
| products: | ||
| - id: cloud-kubernetes | ||
| --- | ||
|
|
||
| # Deploy {{package-registry}} on {{eck}} [k8s-package-registry] | ||
|
|
||
| The {{package-registry}} is a service that stores Elastic package definitions in a central location, making it easier to manage integrations in air-gapped environments or when you need to use a private registry. You can deploy and manage the {{package-registry}} (EPR) as a {{k8s}} resource using ECK. When deployed with ECK, the registry runs as a containerized service in your {{k8s}} cluster and can be used by {{kib}} instances to download and manage integration packages for {{fleet}}. | ||
|
|
||
| ## Deploy the Package Registry | ||
|
|
||
| To deploy the {{package-registry}}, create a `PackageRegistry` resource: | ||
|
|
||
| ```yaml subs=true | ||
| apiVersion: packageregistry.k8s.elastic.co/v1alpha1 | ||
naemono marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| kind: PackageRegistry | ||
| metadata: | ||
| name: package-registry-sample | ||
| namespace: default | ||
| spec: | ||
| version: {{version.stack}} | ||
| count: 1 | ||
| ``` | ||
|
|
||
| The operator automatically creates the necessary {{k8s}} resources, including: | ||
|
|
||
| * A Deployment for the {{package-registry}} pods | ||
| * A Service to expose the {{package-registry}} within your cluster | ||
| * TLS certificates for secure communication | ||
|
|
||
| ## Connect {{kib}} to the Package Registry | ||
|
|
||
| After deploying the {{package-registry}}, configure your {{kib}} instance to use it by setting the `spec.packageRegistryRef` field: | ||
|
|
||
| ```yaml subs=true | ||
| apiVersion: kibana.k8s.elastic.co/v1 | ||
| kind: Kibana | ||
| metadata: | ||
| name: kibana-sample | ||
| namespace: default | ||
| spec: | ||
| version: {{version.stack}} | ||
| count: 1 | ||
| packageRegistryRef: | ||
| name: package-registry-sample | ||
| ``` | ||
|
|
||
| Refer to the [recipes directory](https://github.com/elastic/cloud-on-k8s/tree/{{version.eck | M.M}}/config/recipes/packageregistry) in the ECK source repository for additional configuration examples. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Packages are not available | ||
|
|
||
| Since the {{package-registry}} distribution images contain a snapshot of packages, if you are seeing issues where packages are not available, ensure you're using the correct image version that is equal to or greater than your {{stack}} version. For the latest packages, use the `production` or `lite` distribution tags, for example: | ||
|
|
||
| * `docker.elastic.co/package-registry/distribution:production` - All packages from the production registry | ||
| * `docker.elastic.co/package-registry/distribution:lite` - Subset of commonly used packages | ||
|
|
||
| ```yaml subs=true | ||
| apiVersion: packageregistry.k8s.elastic.co/v1alpha1 | ||
| kind: PackageRegistry | ||
| metadata: | ||
| name: package-registry-sample | ||
| namespace: default | ||
| spec: | ||
| version: {{version.stack}} | ||
| count: 1 | ||
| image: docker.elastic.co/package-registry/distribution:production-{{version.stack}} | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| * [](configuration-fleet.md) | ||
| * [](air-gapped-install.md) | ||
| * [](/reference/fleet/epr-proxy-setting.md) | ||
| * [](/reference/fleet/air-gapped.md#air-gapped-diy-epr) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.