Skip to content

Commit

Permalink
Add version popout to "Packaged Distributions" table (#3842)
Browse files Browse the repository at this point in the history
* Add "version notice" popouts to Packaged Distributions table

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Remove old link to conformance proposal

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Make button colors less vivid to avoid distraction

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Avoid strange wrapping of "release notes" links

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Remove icons

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Make all versions blue

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Use outline rather than solid color

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Make all second-paragraph popups the same.

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Run `get_new_releases.sh` to get the 1.9.1 release

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

---------

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
  • Loading branch information
thesuperzapper authored Nov 7, 2024
1 parent 9982fe8 commit 90f4b7e
Show file tree
Hide file tree
Showing 30 changed files with 347 additions and 18 deletions.
10 changes: 10 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
// --------------------------------------------------
// popover styles
// --------------------------------------------------
.popover-header {
color: #fff;
font-weight: 600;
background-color: $dark;
padding: 0.75rem;
}

// --------------------------------------------------
// reduce padding for small screens
// --------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title = "Pipelines API Reference (v1beta1)"
description = "API Reference for Kubeflow Pipelines API - v1beta1"
weight = 3

swaggerui = true
+++

{{% alert title="Old Version" color="warning" %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title = "Pipelines API Reference (v2beta1)"
description = "API Reference for Kubeflow Pipelines API - v2beta1"
weight = 3

swaggerui = true
+++

This document describes the API specification for the `v2beta1` Kubeflow Pipelines REST API.
Expand Down
91 changes: 91 additions & 0 deletions content/en/docs/started/installing-kubeflow/get_new_releases.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#!/usr/bin/env bash

set -euo pipefail

THIS_SCRIPT_PATH=$(cd "$(dirname "$0")" && pwd)
cd "$THIS_SCRIPT_PATH"

GITHUB_ORGANIZATION="kubeflow"
GITHUB_REPOSITORY="manifests"

# ensure bash version 4.4+
if [[ ${BASH_VERSINFO[0]} -lt 4 || (${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 4) ]]; then
echo ">>> ERROR: Bash version 4.4+ is required to run this script, current version: '${BASH_VERSION}'"
exit 1
fi

# ensure 'jq' is installed
if [[ -z "$(command -v jq)" ]]; then
echo ">>> ERROR: 'jq' must be installed to run this script"
exit 1
fi

#######################################
# Latest release
#######################################

# fetch the latest release from the GitHub API
GITHUB_API_URL="https://api.github.com/repos/${GITHUB_ORGANIZATION}/${GITHUB_REPOSITORY}/releases/latest"
echo ">>> Fetching latest release from: ${GITHUB_API_URL}"
latest_release_json=$(curl -sSfL "$GITHUB_API_URL")

# get the latest release details
latest_release_tag=$(echo "$latest_release_json" | jq -r '.tag_name')
latest_release_url=$(echo "$latest_release_json" | jq -r '.html_url')
latest_commit_date=$(echo "$latest_release_json" | jq -r '.created_at')
latest_publish_date=$(echo "$latest_release_json" | jq -r '.published_at')

# create the latest release file
latest_release_file="./release-info/latest.json"
echo ">>> Updating latest release file: ${latest_release_file}"
cat > "$latest_release_file" <<EOF
{
"tag": "${latest_release_tag}",
"url": "${latest_release_url}",
"commit_date": "${latest_commit_date}",
"publish_date": "${latest_publish_date}"
}
EOF

#######################################
# All releases
#######################################

# fetch the releases from the GitHub API
GITHUB_API_URL="https://api.github.com/repos/${GITHUB_ORGANIZATION}/${GITHUB_REPOSITORY}/releases?per_page=100"
echo ">>> Fetching releases from: ${GITHUB_API_URL}"
releases_json=$(curl -sSfL "$GITHUB_API_URL")

# get the list of releases
releases_list=$(echo "$releases_json" | jq -c '.[]?')

# for each release, update its .json file in this folder
IFS=$'\n'
for release_json in $releases_list; do

# skip pre-releases and drafts
is_pre_release=$(echo "$release_json" | jq -r '.prerelease')
is_draft=$(echo "$release_json" | jq -r '.draft')
if [[ "$is_pre_release" == "true" || "$is_draft" == "true" ]]; then
continue
fi

# get the release details
release_tag=$(echo "$release_json" | jq -r '.tag_name')
release_url=$(echo "$release_json" | jq -r '.html_url')
commit_date=$(echo "$release_json" | jq -r '.created_at')
publish_date=$(echo "$release_json" | jq -r '.published_at')

# create the release file
release_file="./release-info/${release_tag}.json"
echo ">>> Updating release file: ${release_file}"
cat > "$release_file" <<EOF
{
"tag": "${release_tag}",
"url": "${release_url}",
"commit_date": "${commit_date}",
"publish_date": "${publish_date}"
}
EOF

done
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,9 @@ a simplified installation and management experience for your **Kubeflow Platform
can be deployed on [all certified Kubernetes distributions](https://kubernetes.io/partners/#conformance),
while others target a specific platform (e.g. EKS or GKE).

{{% alert title="Note" color="warning" %}}
{{% alert title="Note" color="dark" %}}
Packaged distributions are developed and supported by their respective maintainers.
The Kubeflow community <strong>does not endorse or certify</strong> any specific distribution.

In the near future, there are plans to introduce <a href="https://github.com/kubeflow/community/blob/master/proposals/kubeflow-conformance-program-proposal.md">conformance testing for distributions</a>, you may track progress on this initiative by following <a href="https://github.com/kubeflow/kubeflow/issues/6485">kubeflow/kubeflow#6485</a>.
{{% /alert %}}

The following table lists distributions which are <em>maintained</em> by their respective maintainers:
Expand All @@ -189,7 +187,8 @@ The following table lists distributions which are <em>maintained</em> by their r
Amazon Web Services
</td>
<td>
{{% aws/latest-version %}} <sup>[<a href="https://github.com/awslabs/kubeflow-manifests/releases">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% aws/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://github.com/awslabs/kubeflow-manifests/releases">[Release Notes]</a></sup>
</td>
<td>
Amazon Elastic Kubernetes Service (EKS)
Expand All @@ -204,7 +203,8 @@ The following table lists distributions which are <em>maintained</em> by their r
<br><small>deployKF</small>
</td>
<td>
{{% deploykf/latest-version %}} <sup>[<a href="https://www.deploykf.org/releases/tool-versions/#kubeflow-ecosystem">Version Matrix</a>]</sup>
{{< kf-version-notice >}}{{% deploykf/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://www.deploykf.org/releases/tool-versions/#kubeflow-ecosystem">[Version Matrix]</a></sup>
</td>
<td>
All Certified Kubernetes Distributions
Expand All @@ -219,7 +219,8 @@ The following table lists distributions which are <em>maintained</em> by their r
<br><small>Charmed Kubeflow</small>
</td>
<td>
{{% canonical/latest-version %}} <sup>[<a href="https://charmed-kubeflow.io/docs/release-notes">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% canonical/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://charmed-kubeflow.io/docs/release-notes">[Release Notes]</a></sup>
</td>
<td>
All Certified Kubernetes Distributions
Expand All @@ -233,7 +234,8 @@ The following table lists distributions which are <em>maintained</em> by their r
Google Cloud
</td>
<td>
{{% gke/latest-version %}} <sup>[<a href="https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/changelog/">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% gke/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/changelog/">[Release Notes]</a></sup>
</td>
<td>
Google Kubernetes Engine (GKE)
Expand All @@ -247,7 +249,8 @@ The following table lists distributions which are <em>maintained</em> by their r
IBM Cloud
</td>
<td>
{{% iks/latest-version %}} <sup>[<a href="https://github.com/IBM/manifests/releases/tag/v{{% iks/latest-version %}}">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% iks/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://github.com/IBM/manifests/releases">[Release Notes]</a></sup>
</td>
<td>
IBM Cloud Kubernetes Service (IKS)
Expand All @@ -261,7 +264,8 @@ The following table lists distributions which are <em>maintained</em> by their r
Microsoft Azure
</td>
<td>
{{% azure/latest-version %}} <sup>[<a href="https://github.com/Azure/kubeflow-aks/releases/tag/v{{% azure/latest-version %}}">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% azure/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://github.com/Azure/kubeflow-aks/releases">[Release Notes]</a></sup>
</td>
<td>
Azure Kubernetes Service (AKS)
Expand All @@ -275,7 +279,7 @@ The following table lists distributions which are <em>maintained</em> by their r
Nutanix
</td>
<td>
{{% nutanix/latest-version %}}
{{< kf-version-notice >}}{{% nutanix/latest-version %}}{{< /kf-version-notice >}}
</td>
<td>
Nutanix Kubernetes Engine
Expand All @@ -289,7 +293,8 @@ The following table lists distributions which are <em>maintained</em> by their r
QBO
</td>
<td>
{{% qbo/latest-version %}} <sup>[<a href="https://github.com/alexeadem/qbo-ce/blob/main/CHANGELOG.md">Release Notes</a>]</sup>
{{< kf-version-notice >}}{{% qbo/latest-version %}}{{< /kf-version-notice >}}
<sup><a href="https://github.com/alexeadem/qbo-ce/blob/main/CHANGELOG.md">[Release Notes]</a></sup>
</td>
<td>
QBO Kubernetes Engine (QKE)
Expand All @@ -304,7 +309,7 @@ The following table lists distributions which are <em>maintained</em> by their r
<br><small>Open Data Hub</small>
</td>
<td>
{{% redhat/latest-version %}}
{{< kf-version-notice >}}{{% redhat/latest-version %}}{{< /kf-version-notice >}}
</td>
<td>
OpenShift
Expand All @@ -318,7 +323,7 @@ The following table lists distributions which are <em>maintained</em> by their r
VMware
</td>
<td>
{{% vmware/latest-version %}}
{{< kf-version-notice >}}{{% vmware/latest-version %}}{{< /kf-version-notice >}}
</td>
<td>
VMware vSphere
Expand Down Expand Up @@ -354,6 +359,7 @@ instructions in the `README` of the [`kubeflow/manifests`](https://github.com/ku
The Kubeflow manifests provide a quick way to get a minimum viable Kubeflow Platform up and running.
The Kubeflow community support for Kubeflow manifests is only best-effort, non-commercial and not guaranteed for environment-specific issues or custom configurations.
Nevertheless, we welcome contributions and bug reports very much.

For commercial production-level usage and support there are many options. You can use a third-party commercial distribution, hire consultants or build up the knowledge yourself to maintain and extend your Kubeflow installation.
{{% /alert %}}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.9.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.9.1",
"commit_date": "2024-10-24T20:57:31Z",
"publish_date": "2024-10-28T14:09:47Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v0.6.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v0.6.0",
"commit_date": "2019-07-18T20:34:19Z",
"publish_date": "2019-07-18T21:24:06Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v0.6.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v0.6.1",
"commit_date": "2019-07-26T22:45:58Z",
"publish_date": "2019-07-30T21:52:06Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v0.6.2",
"url": "https://github.com/kubeflow/manifests/releases/tag/v0.6.2",
"commit_date": "2019-08-24T19:58:23Z",
"publish_date": "2019-08-28T02:45:15Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.0.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.0.1",
"commit_date": "2020-03-18T19:58:42Z",
"publish_date": "2020-03-18T20:15:26Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.0.2",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.0.2",
"commit_date": "2020-04-16T23:17:27Z",
"publish_date": "2020-04-17T22:00:20Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.1.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.1.0",
"commit_date": "2020-07-26T00:07:36Z",
"publish_date": "2020-11-09T08:16:45Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.2.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.2.0",
"commit_date": "2020-11-20T17:12:51Z",
"publish_date": "2020-11-20T19:29:14Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.3.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.3.0",
"commit_date": "2021-04-21T22:48:42Z",
"publish_date": "2021-06-02T21:53:55Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.3.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.3.1",
"commit_date": "2021-07-20T09:49:15Z",
"publish_date": "2021-08-03T14:14:30Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.4.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.4.0",
"commit_date": "2021-10-08T17:55:24Z",
"publish_date": "2021-10-12T03:15:04Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.4.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.4.1",
"commit_date": "2021-12-22T16:25:41Z",
"publish_date": "2021-12-23T22:13:01Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.5.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.5.0",
"commit_date": "2022-03-10T17:01:57Z",
"publish_date": "2022-03-10T17:32:42Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.5.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.5.1",
"commit_date": "2022-06-15T18:35:53Z",
"publish_date": "2022-06-15T18:44:13Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.6.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.6.0",
"commit_date": "2022-09-07T17:41:26Z",
"publish_date": "2022-09-07T18:31:34Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.6.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.6.1",
"commit_date": "2022-10-10T15:03:58Z",
"publish_date": "2022-10-10T15:31:34Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.7.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.7.0",
"commit_date": "2023-03-29T15:17:36Z",
"publish_date": "2023-03-29T15:47:56Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.8.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.8.0",
"commit_date": "2023-11-01T16:15:57Z",
"publish_date": "2023-11-01T16:22:22Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.8.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.8.1",
"commit_date": "2024-03-04T12:04:42Z",
"publish_date": "2024-04-08T16:53:00Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.9.0",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.9.0",
"commit_date": "2024-07-22T11:30:01Z",
"publish_date": "2024-07-22T11:39:31Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tag": "v1.9.1",
"url": "https://github.com/kubeflow/manifests/releases/tag/v1.9.1",
"commit_date": "2024-10-24T20:57:31Z",
"publish_date": "2024-10-28T14:09:47Z"
}
Loading

0 comments on commit 90f4b7e

Please sign in to comment.