Skip to content
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

Add FreeBSD installation instructions #321

Merged
merged 3 commits into from
Oct 4, 2021

Conversation

smortex
Copy link
Contributor

@smortex smortex commented Sep 20, 2021

FreeBSD ports for OpenSearch and OpenSearch-Dashboards have been
committed to the FreeBSD ports tree, and packages will be available soon
to FreeBSD users through the regular package management system.

Add FreeBSD to the list of platforms. Because installation instruction
do not change based on the architecture, add a "All" architecture to
avoid duplicating the same information multiple times.

Also include a link to the port page on FreshPorts which allow to
"conveniently" see the port history (in a more convenient way than
cgit).

While here, adjust the list of all artifacts to order them
alphabetically in the artifacts directory.

@smortex
Copy link
Contributor Author

smortex commented Sep 20, 2021

Screenshot from the rendering of the PR:

image

FreeBSD ports for OpenSearch and OpenSearch-Dashboards have been
committed to the FreeBSD ports tree, and packages will be available soon
to FreeBSD users through the regular package management system.

Add FreeBSD to the list of platforms.  Because installation instruction
do not change based on the architecture, add a "All" architecture to
avoid duplicating the same information multiple times.

Also include a link to the port page on FreshPorts which allow to
"conveniently" see the port history (in a more convenient way than
cgit).

While here, adjust the list of all artifacts to order them
alphabetically in the artifacts directory.
architecture: all
slug: opensearch-1.0.1-freebsd-all
category: opensearch
type: pkg
Copy link
Member

Choose a reason for hiding this comment

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

Humm. pkg is a bit overloaded as it's used in macos too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Quite agree… Maybe something like 'system-package' to insist on the way this is managed using the regular package manager of the system?

artifact_id: opensearch-dashboards
architecture: all
platform: freebsd
type: pkg
Copy link
Member

Choose a reason for hiding this comment

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

see above. I think it might need some disambiguation.

@@ -46,11 +48,13 @@
- x64
- arm64
- x86
- all
Copy link
Member

Choose a reason for hiding this comment

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

would noarch work better than all? I've not settled on this... 🤔

Copy link
Contributor Author

@smortex smortex Sep 20, 2021

Choose a reason for hiding this comment

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

noarch make me think "platform agnostic" (e.g. we use noarch to refer to FreeBSD packages that are identical on all architectures, e.g. python / ruby). Here we indeed have platform-dependent packages because the application bundle architecture specific binaries (jna for OpenSearch; re2 for OpenSearch-Dashboards).

Maybe any is a better fit?

Copy link
Member

Choose a reason for hiding this comment

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

@smortex OK - so what architectures are supported in the FreeBSD version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stockholmux we currently have i386, amd64 (x86, 32 and 64 bits) and aarch64 (arm 64 bits) packages available. Other platforms might not have packages because of a failing dependency (I am not sure openjdk11 build on 32 bit ARM) or be delayed because of limited build resources (I only saw aarch64 packages today).

Copy link
Member

Choose a reason for hiding this comment

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

OK. That makes sense @smortex I think it makes sense to more explicit here (repeating near identical /_artifact/ files) than less (using all or any). Two reasons:

  1. I'd like these files to be useful to eventually to power an API and making sure there is an explicit entry for each architecture would simplify the the implementation.
  2. Who knows, maybe someone ports OpenSearch to RISC-V (or whatever) and would be frustrated all not being true.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! How should we name 32bit x86 (i386 architecture with FreeBSD terminology)? x86 (what Microsoft seems to use for this architecture)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Replying to myself: x86 is not listed in the architectures list but appear in the architecture_order so should be fine :-)

`pkg` is already something used by MacOS, so remove this ambiguity.
@smortex
Copy link
Contributor Author

smortex commented Sep 24, 2021

As of today, textproc/opensearch and textproc/opensearch-dashboards packages are available for FreeBSD 11, 12, 13 and 14 for both amd64 and i386 (except FreeBSD 12 amd64 where a build dependency seems to be broken).

The packages availability matrix is visible in FreshPorts at the URI the PR associate with the artifacts.

@dblock
Copy link
Member

dblock commented Sep 27, 2021

🚀

@dblock dblock closed this Sep 27, 2021
@dblock dblock reopened this Sep 27, 2021
Drop the generic `all` which is indeed not an architecture and might
lead users to think that packages are available for architecture
actually not supported.
@stockholmux
Copy link
Member

Scheduled for production on 2021/10/4

@stockholmux stockholmux merged commit d21be6e into opensearch-project:main Oct 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants