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.

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

Add FreeBSD installation instructions #321

Merged
merged 3 commits into from
Oct 4, 2021
Merged

Add FreeBSD installation instructions #321

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acceb94
Add FreeBSD installation instructions
smortex Sep 20, 2021
db2f542
Change FreeBSD artifacts type to `system-package`
smortex Sep 20, 2021
5ef2818
Explicitly list all FreeBSD package architectures
smortex Sep 27, 2021
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
12 changes: 12 additions & 0 deletions _artifacts/opensearch-1.0/all/opensearch-1.0.1-freebsd-all.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
role: daemon
artifact_id: opensearch
version: 1.0.1
platform: freebsd
architecture: all
slug: opensearch-1.0.1-freebsd-all
category: opensearch
type: system-package
freebsd_package_name: opensearch
link: https://www.freshports.org/textproc/opensearch
---
13 changes: 13 additions & 0 deletions _artifacts/opensearch-1.0/all/opensearch-dashboards-1.0.1-freebsd-all.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
role: ui
title: OpenSearch Dashboards
artifact_id: opensearch-dashboards
architecture: all
platform: freebsd
type: system-package
category: opensearch-dashboards
slug: opensearch-dashboards-1.0.1-freebsd-all
version: 1.0.1
freebsd_package_name: opensearch-dashboards
link: https://www.freshports.org/textproc/opensearch-dashboards
---
14 changes: 13 additions & 1 deletion _layouts/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
platforms:
windows: "Windows"
linux: "Linux"
freebsd: "FreeBSD"
macos: macOS
java: "Java"
docker: Docker
Expand All @@ -30,7 +31,9 @@
msi: "Installer (msi)"
jar: ".jar"
docker_hub: 'Dockerfile'
system-package: "System package"
architectures:
all: "All"
arm64: "ARM64"
x64: "x64"
jvm: Java Virtual Machine
Expand All @@ -46,11 +49,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 •
edited
Loading

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 :-)

- jvm

platform_order:
- linux
- docker
- freebsd
- macos
- windows
- java
Expand Down Expand Up @@ -193,6 +198,13 @@ <h3 class="artifact-name" id="{{component.artifact}}">{{ name_pretty }}</h3>
class="cta">Download</a> </div>{% endcapture %}
{% assign artifact_extras = artifact_extras | append: artifact_extra %}
{% endif %}
{% if details.freebsd_package_name %}
{% capture artifact_extra %}<div class="extra_links extra_{{artifact_id}}">
<p>Install from FreeBSD packages:</p>
<pre># pkg install {{details.freebsd_package_name}}</pre>
</div>{% endcapture %}
{% assign artifact_extras = artifact_extras | append: artifact_extra %}
{% endif %}
{% if details.link %}
{% capture artifact_extra %}<div class="extra_links extra_{{artifact_id}}">
<a href="{{details.link}}" target="_blank" class="cta">Get it</a>
Expand Down Expand Up @@ -271,4 +283,4 @@ <h3 class="artifact-name" id="{{component.artifact}}">{{ name_pretty }}</h3>
{% endcapture %}

{% include copy_banner.html %}
{% include base_3col.html %}
{% include base_3col.html %}
4 changes: 2 additions & 2 deletions artifacts/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
<ul class="tree">
{% for id_group in artifacts_by_id %}
<li id="{{id_group.name}}">{{ id_group.name }}
{% assign artifacts_by_platform = id_group.items | group_by: "platform" %}
{% assign artifacts_by_platform = id_group.items | sort: "platform" | group_by: "platform" %}
<ul class="tree">
{% for platform_group in artifacts_by_platform %}
{% assign architecture_group = platform_group.items | group_by: "architecture" %}
{% assign architecture_group = platform_group.items | sort: "name" | group_by: "architecture" %}
{% for artifacts in architecture_group %}
<li>{{ platform_group.name }}-{{ artifacts.name }}
<ul class="tree">
Expand Down