You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@heron.apache.org by ni...@apache.org on 2022/02/26 07:11:54 UTC

[incubator-heron] 01/01: Documentation cleanup

This is an automated email from the ASF dual-hosted git repository.

nicknezis pushed a commit to branch feature/change-centos-to-rockylinux
in repository https://gitbox.apache.org/repos/asf/incubator-heron.git

commit b1eb04dfd33359c52aa5fe7df28f271d2acf01db
Author: Nicholas Nezis <ni...@gmail.com>
AuthorDate: Sat Feb 26 02:11:33 2022 -0500

    Documentation cleanup
---
 bazel_configure.py                                 |  2 +-
 .../{Dockerfile.centos8 => Dockerfile.rocky8}      |  2 ++
 ...kerfile.dist.centos8 => Dockerfile.dist.rocky8} |  0
 docker/scripts/build-artifacts.sh                  |  2 +-
 docker/scripts/build-base.sh                       |  2 +-
 docker/scripts/build-docker.sh                     |  2 +-
 docker/scripts/build-exec-docker.sh                |  2 +-
 docker/scripts/ci-docker.sh                        |  2 +-
 docker/scripts/compile-platform.sh                 |  2 ++
 docker/scripts/dev-env-create.sh                   |  2 +-
 docker/scripts/test-platform.sh                    |  2 ++
 docker/scripts/test-unittest.sh                    |  4 ++--
 .../test/{Dockerfile.centos8 => Dockerfile.rocky8} |  2 ++
 scripts/ci/README.md                               |  4 ++--
 scripts/ci/build_docker_image.sh                   |  2 +-
 scripts/ci/build_release_packages.sh               |  2 +-
 scripts/detect_os_type.sh                          |  2 +-
 website2/docs/compiling-docker.md                  | 10 ++++----
 website2/docs/compiling-linux.md                   | 12 +++++-----
 website2/docs/compiling-overview.md                |  8 +++----
 website2/docs/getting-started-local-single-node.md |  2 +-
 website2/website/pages/en/download.js              | 28 +++++++++++-----------
 22 files changed, 52 insertions(+), 44 deletions(-)

diff --git a/bazel_configure.py b/bazel_configure.py
index 95e3ee4..5b08afa 100755
--- a/bazel_configure.py
+++ b/bazel_configure.py
@@ -26,7 +26,7 @@
 #
 #  cd docker
 #  ./build-artifacts.sh ubuntu20.04 0.12.0 .
-#  ./build-artifacts.sh centos8 0.12.0 .
+#  ./build-artifacts.sh rocky8 0.12.0 .
 #
 import os
 import re
diff --git a/docker/compile/Dockerfile.centos8 b/docker/compile/Dockerfile.rocky8
similarity index 98%
rename from docker/compile/Dockerfile.centos8
rename to docker/compile/Dockerfile.rocky8
index 52d643e..cbf5a7b 100644
--- a/docker/compile/Dockerfile.centos8
+++ b/docker/compile/Dockerfile.rocky8
@@ -20,6 +20,8 @@ FROM rockylinux:8.5
 # This is passed to the heron build command via the --config flag
 ENV TARGET_PLATFORM linux
 
+ENV LC_ALL en_US.utf8
+
 RUN yum -y upgrade
 RUN yum -y install \
       ant \
diff --git a/docker/dist/Dockerfile.dist.centos8 b/docker/dist/Dockerfile.dist.rocky8
similarity index 100%
rename from docker/dist/Dockerfile.dist.centos8
rename to docker/dist/Dockerfile.dist.rocky8
diff --git a/docker/scripts/build-artifacts.sh b/docker/scripts/build-artifacts.sh
index 8aa3613..b2cbd77 100755
--- a/docker/scripts/build-artifacts.sh
+++ b/docker/scripts/build-artifacts.sh
@@ -166,7 +166,7 @@ case $# in
     echo "  "
     echo "Script to build heron artifacts for different platforms"
     echo "  "
-    echo "Platforms Supported: darwin, debian10, ubuntu20.04, centos8"
+    echo "Platforms Supported: darwin, debian10, ubuntu20.04, rocky8"
     echo "  "
     echo "Example:"
     echo "  ./build-artifacts.sh ubuntu20.04 0.12.0 ."
diff --git a/docker/scripts/build-base.sh b/docker/scripts/build-base.sh
index b0d3eb7..7da1947 100755
--- a/docker/scripts/build-base.sh
+++ b/docker/scripts/build-base.sh
@@ -91,7 +91,7 @@ case $# in
     echo "  "
     echo "Usage: $0 <platform> <version_string> <output-directory>"
     echo "  "
-    echo "Platforms Supported: darwin, debian10, ubuntu20.04, centos8"
+    echo "Platforms Supported: darwin, debian10, ubuntu20.04, rocky8"
     echo "  "
     echo "Example:"
     echo "  ./build-base.sh ubuntu20.04 0.12.0 ~/ubuntu"
diff --git a/docker/scripts/build-docker.sh b/docker/scripts/build-docker.sh
index 37f157a..909002b 100755
--- a/docker/scripts/build-docker.sh
+++ b/docker/scripts/build-docker.sh
@@ -96,7 +96,7 @@ case $# in
     echo "Usage: $0 <platform> <version_string> <artifact-directory> [-s|--squash]"
     echo "  "
     echo "Argument options:"
-    echo "  <platform>: darwin, debian10, ubuntu20.04, centos8"
+    echo "  <platform>: darwin, debian10, ubuntu20.04, rocky8"
     echo "  <version_string>: Version of Heron build, e.g. v0.17.5.1-rc"
     echo "  <artifact-directory>: Location of compiled Heron artifact"
     echo "  [-s|--squash]: Enables using Docker experimental feature --squash"
diff --git a/docker/scripts/build-exec-docker.sh b/docker/scripts/build-exec-docker.sh
index 9532c25..ba5175d 100755
--- a/docker/scripts/build-exec-docker.sh
+++ b/docker/scripts/build-exec-docker.sh
@@ -86,7 +86,7 @@ case $# in
   *)
     echo "Usage: $0 <platform> <version_string> <output-directory> "
     echo "  "
-    echo "Platforms Supported: darwin, debian10, ubuntu20.04, centos8"
+    echo "Platforms Supported: darwin, debian10, ubuntu20.04, rocky8"
     echo "  "
     echo "Example:"
     echo "  ./build-exec-docker.sh ubuntu20.04 0.12.0 ."
diff --git a/docker/scripts/ci-docker.sh b/docker/scripts/ci-docker.sh
index 4307cff..fce34ff 100755
--- a/docker/scripts/ci-docker.sh
+++ b/docker/scripts/ci-docker.sh
@@ -139,7 +139,7 @@ case $# in
   *)
     echo "Usage: $0 <operation> <platform> <version_string> <tag-prefix> <input-output-directory> "
     echo "  "
-    echo "Platforms Supported: latest, ubuntu20.04, centos8, debian10"
+    echo "Platforms Supported: ubuntu20.04, rocky8, debian10"
     echo "  "
     echo "Example:"
     echo "  $0 build ubuntu20.04 0.12.0 heron ."
diff --git a/docker/scripts/compile-platform.sh b/docker/scripts/compile-platform.sh
index e75f3df..a96bc15 100755
--- a/docker/scripts/compile-platform.sh
+++ b/docker/scripts/compile-platform.sh
@@ -40,6 +40,8 @@ if [[ "$TARGET_PLATFORM" =~ "ubuntu" ]]; then
   CONFIG_PLATFORM=linux_nostyle
 elif [[ "$TARGET_PLATFORM" =~ "centos" ]]; then
   CONFIG_PLATFORM=linux_nostyle
+elif [[ "$TARGET_PLATFORM" =~ "rocky" ]]; then
+  CONFIG_PLATFORM=linux_nostyle
 elif [[ "$TARGET_PLATFORM" =~ "debian" ]]; then
   CONFIG_PLATFORM=linux_nostyle
 elif [[ "$TARGET_PLATFORM" =~ "darwin" ]]; then
diff --git a/docker/scripts/dev-env-create.sh b/docker/scripts/dev-env-create.sh
index 760a337..f8fd362 100755
--- a/docker/scripts/dev-env-create.sh
+++ b/docker/scripts/dev-env-create.sh
@@ -43,7 +43,7 @@ case $# in
 esac
 
 # Default platform is ubuntu18.04. Other available platforms
-# include centos8, debian10, ubuntu18.04
+# include rocky8, debian10, ubuntu18.04
 TARGET_PLATFORM=${2:-"ubuntu18.04"}
 SCRATCH_DIR="$HOME/.heron-docker"
 REPOSITORY="heron-dev"
diff --git a/docker/scripts/test-platform.sh b/docker/scripts/test-platform.sh
index 70505b4..07125f2 100755
--- a/docker/scripts/test-platform.sh
+++ b/docker/scripts/test-platform.sh
@@ -40,6 +40,8 @@ if [[ "$TARGET_PLATFORM" =~ "ubuntu" ]]; then
   CONFIG_PLATFORM=linux_nostyle
 elif [[ "$TARGET_PLATFORM" =~ "centos" ]]; then
   CONFIG_PLATFORM=linux_nostyle
+elif [[ "$TARGET_PLATFORM" =~ "rocky" ]]; then
+  CONFIG_PLATFORM=linux_nostyle
 elif [[ "$TARGET_PLATFORM" =~ "darwin" ]]; then
   CONFIG_PLATFORM=darwin
 elif [[ "$TARGET_PLATFORM" =~ "debian" ]]; then
diff --git a/docker/scripts/test-unittest.sh b/docker/scripts/test-unittest.sh
index aca54b0..37e7c86 100755
--- a/docker/scripts/test-unittest.sh
+++ b/docker/scripts/test-unittest.sh
@@ -163,10 +163,10 @@ case $# in
     echo "  "
     echo "Script to test heron artifacts for different platforms"
     echo "  "
-    echo "Platforms Supported: darwin, ubuntu18.04, centos8"
+    echo "Platforms Supported: darwin, ubuntu18.04, rocky8"
     echo "  "
     echo "Example:"
-    echo "  ./test-unittest.sh centos8 0.20.2"
+    echo "  ./test-unittest.sh rocky8 0.20.2"
     echo "  "
     echo "NOTE: If running on OSX, the output directory will need to "
     echo "      be under /Users so virtualbox has access to."
diff --git a/docker/test/Dockerfile.centos8 b/docker/test/Dockerfile.rocky8
similarity index 98%
rename from docker/test/Dockerfile.centos8
rename to docker/test/Dockerfile.rocky8
index 4272f28..c32fb55 100644
--- a/docker/test/Dockerfile.centos8
+++ b/docker/test/Dockerfile.rocky8
@@ -20,6 +20,8 @@ FROM rockylinux:8.5
 # This is passed to the heron build command via the --config flag
 ENV TARGET_PLATFORM linux
 
+ENV LC_ALL en_US.utf8
+
 RUN yum -y upgrade
 RUN yum -y install \
       automake \
diff --git a/scripts/ci/README.md b/scripts/ci/README.md
index 03cd847..4472bec 100644
--- a/scripts/ci/README.md
+++ b/scripts/ci/README.md
@@ -32,9 +32,9 @@ set -o pipefail
 # Install bazel (linux build) because CI hosts may not have it installed
 bash scripts/ci/setup_bazel.sh linux
 
-# Build v0.20.1-incubating packages for centos8 and put in artifacts folder
+# Build v0.20.1-incubating packages for rocky8 and put in artifacts folder
 HERON_BUILD_USER=release-agent
-bash scripts/ci/build_release_packages.sh v0.20.1-incubating centos8 artifacts
+bash scripts/ci/build_release_packages.sh v0.20.1-incubating rocky8 artifacts
 
 ```
 
diff --git a/scripts/ci/build_docker_image.sh b/scripts/ci/build_docker_image.sh
index e4b45eb..38bc4b6 100644
--- a/scripts/ci/build_docker_image.sh
+++ b/scripts/ci/build_docker_image.sh
@@ -19,7 +19,7 @@
 # Build docker image to be released
 # parameters:
 # 1. version tag, e.g. v0.20.1-incubating
-# 2. build os, e.g. debian10, centos8
+# 2. build os, e.g. debian10, rocky8
 # 3. output dir
 
 # Related environment variables
diff --git a/scripts/ci/build_release_packages.sh b/scripts/ci/build_release_packages.sh
index 7bca7d1..4cec551 100644
--- a/scripts/ci/build_release_packages.sh
+++ b/scripts/ci/build_release_packages.sh
@@ -19,7 +19,7 @@
 # Build packages to be released
 # parameters:
 # 1. version tag, e.g. v0.20.1-incubating
-# 2. build os, e.g. darwin, centos8
+# 2. build os, e.g. darwin, rocky8
 # 3. output dir
 
 # Related environment variables
diff --git a/scripts/detect_os_type.sh b/scripts/detect_os_type.sh
index 63fb3ec..0ce3233 100755
--- a/scripts/detect_os_type.sh
+++ b/scripts/detect_os_type.sh
@@ -25,7 +25,7 @@ function platform {
    *)
      echo "WARNING: Your platform is not currently supported!" >&2
      echo "Currently supported platforms are:" >&2
-     echo "  darwin, ubuntu, and centos"
+     echo "  darwin, ubuntu, rocky and centos"
      exit 1
      ;;
  esac
diff --git a/website2/docs/compiling-docker.md b/website2/docs/compiling-docker.md
index f6d6345..04c8b80 100644
--- a/website2/docs/compiling-docker.md
+++ b/website2/docs/compiling-docker.md
@@ -65,7 +65,7 @@ Script to build heron docker image for different platforms
 Usage: ./docker/scripts/build-docker.sh <platform> <version_string> <artifact-directory> [-s|--squash]
   
 Argument options:
-  <platform>: darwin, debian10, ubuntu20.04, centos8
+  <platform>: darwin, debian10, ubuntu20.04, rocky8
   <version_string>: Version of Heron build, e.g. v0.17.5.1-rc
   <artifact-directory>: Location of compiled Heron artifact
   [-s|--squash]: Enables using Docker experimental feature --squash
@@ -82,8 +82,8 @@ The following arguments are required:
 * `platform` --- Currently we are focused on supporting the `debian10` and `ubuntu20.04` platforms.  
 We also support building Heron locally on OSX.  You can specify this as listing `darwin` as the platform.
  All options are:
-   - `centos8`
    - `darwin`
+   - `rocky8`
    - `debian10`
    - `ubuntu18.04`
    - `ubuntu20.04`
@@ -172,7 +172,7 @@ platforms.
 
 To add support for a new platform, add a new `Dockerfile` to that directory and
 append the name of the platform to the name of the file. If you'd like to add
-support for Debian 8, for example, add a file named `Dockerfile.debian8`. Once
+support for Debian 8, for example, add a file named `Dockerfile.debian10`. Once
 you've done that, follow the instructions in the [Docker
 documentation](https://docs.docker.com/engine/articles/dockerfile_best-practices/).
 
@@ -184,7 +184,7 @@ following:
 Here's an example:
 
 ```dockerfile
-FROM centos:centos8
+FROM rockylinux:8.5
  ```
 
 ### Step 2 --- A `TARGET_PLATFORM` environment variable using the [`ENV`](https://docs.docker.com/engine/reference/builder/#env) instruction.
@@ -192,7 +192,7 @@ FROM centos:centos8
 Here's an example:
 
 ```dockerfile
-ENV TARGET_PLATFORM centos
+ENV TARGET_PLATFORM rocky
 ```
 
 ### Step 3 --- A general dependency installation script using a [`RUN`](https://docs.docker.com/engine/reference/builder/#run) instruction.
diff --git a/website2/docs/compiling-linux.md b/website2/docs/compiling-linux.md
index cfc7665..84e94ce 100644
--- a/website2/docs/compiling-linux.md
+++ b/website2/docs/compiling-linux.md
@@ -22,12 +22,12 @@ sidebar_label: Compiling on Linux
 
 Heron can currently be built on the following Linux platforms:
 
-* [Ubuntu 18.04](#building-on-ubuntu-18.04)
-* [CentOS 7](#building-on-centos-7)
+* [Ubuntu 20.04](#building-on-ubuntu-20.04)
+* [Rocky 8](#building-on-rocky-8)
 
-## Building on Ubuntu 18.04
+## Building on Ubuntu 20.04
 
-To build Heron on a fresh Ubuntu 18.04 installation:
+To build Heron on a fresh Ubuntu 20.04 installation:
 
 ### Step 1 --- Update Ubuntu
 
@@ -147,9 +147,9 @@ $ make
 $ sudo make install
 ```
 
-## Building on CentOS 7
+## Building on Rocky 8
 
-To build Heron on a fresh CentOS 7 installation:
+To build Heron on a fresh Rocky 8 installation:
 
 ### Step 1 --- Install the required dependencies
 
diff --git a/website2/docs/compiling-overview.md b/website2/docs/compiling-overview.md
index 087cdaf..6195614 100644
--- a/website2/docs/compiling-overview.md
+++ b/website2/docs/compiling-overview.md
@@ -20,8 +20,8 @@ sidebar_label: Compiling Overview
     under the License.
 -->
 
-Heron is currently available for [Mac OS X 11.01](compiling-osx),
-[Ubuntu 18.04](compiling-linux), and [Debian10](compiling-docker#building-heron).
+Heron is currently available for [Mac OS X 12](compiling-osx),
+[Ubuntu 20.04](compiling-linux), and [Debian10](compiling-docker#building-heron).
  This guide describes the basics of the
 Heron build system. For step-by-step build instructions for other platforms,
 the following guides are available:
@@ -93,9 +93,9 @@ OS-specific configuration using the `--config` flag. The following OS values
 are supported:
 
 * `darwin` (Mac OS X)
-* `ubuntu` (Ubuntu 18.04)
+* `ubuntu` (Ubuntu 20.04)
 * `debian` (Debian10)
-* `centos5` (CentOS 7)
+* `rocky8` (Rocky 8)
 
 For example, on Mac OS X (`darwin`), the following command will build all
 packages:
diff --git a/website2/docs/getting-started-local-single-node.md b/website2/docs/getting-started-local-single-node.md
index 4c56c53..1a0f81a 100644
--- a/website2/docs/getting-started-local-single-node.md
+++ b/website2/docs/getting-started-local-single-node.md
@@ -28,7 +28,7 @@ For other platforms, you need to build from source. Please refer to the [guide t
 Heron tools can be installed using [installation scripts](#using-installation-scripts).
 
 > Note: As of version  0.20.4-incubating, there is a python compatibility on OSX.
-> The supported platforms are centos8, Debian10, and Ubuntu18.04.
+> The supported platforms are rocky8, Debian10, and Ubuntu18.04.
 
 ## Using installation scripts
 
diff --git a/website2/website/pages/en/download.js b/website2/website/pages/en/download.js
index 019da05..b721bf0 100644
--- a/website2/website/pages/en/download.js
+++ b/website2/website/pages/en/download.js
@@ -61,12 +61,12 @@ class Download extends React.Component {
     const latestDebian10TarUrl =  getTarUrl(latestHeronVersion, "debian10");
     const latestArchiveUrl = distUrl(latestHeronVersion, 'bin');
     const latestSrcArchiveUrl = distUrl(latestHeronVersion, 'src')
-    const centos8InstallUrl = getInstallScriptMirrorUrl(latestHeronVersion, "centos8")
-    const centos8InstallCryptoUrl = getInstallScriptCryptoUrl(latestHeronVersion, "centos8")
+    const rocky8InstallUrl = getInstallScriptMirrorUrl(latestHeronVersion, "rocky8")
+    const rocky8InstallCryptoUrl = getInstallScriptCryptoUrl(latestHeronVersion, "rocky8")
     const debian10InstallUrl = getInstallScriptMirrorUrl(latestHeronVersion, "debian10")
     const debian10InstallCryptoUrl = getInstallScriptCryptoUrl(latestHeronVersion, "debian10")
-    const ubuntu1804InstallUrl = getInstallScriptMirrorUrl(latestHeronVersion, "ubuntu18.04")
-    const ubuntu1804InstallCryptoUrl = getInstallScriptCryptoUrl(latestHeronVersion, "ubuntu18.04")
+    const ubuntu2004InstallUrl = getInstallScriptMirrorUrl(latestHeronVersion, "ubuntu20.04")
+    const ubuntu2004InstallCryptoUrl = getInstallScriptCryptoUrl(latestHeronVersion, "ubuntu20.04")
 
 
 
@@ -148,14 +148,14 @@ class Download extends React.Component {
                 <tbody>
 
 
-                  <tr key={'centos-install'}>
-                    <th>centos8</th>
+                  <tr key={'rocky-install'}>
+                    <th>rocky8</th>
                     <td>
-                      <a href={`${centos8InstallUrl}`}> heron-install-0.20.4-incubating-centos8.sh</a>
+                      <a href={`${rocky8InstallUrl}`}> heron-install-0.20.4-incubating-rocky8.sh</a>
                     </td>
                     <td>
-                      <a href={`${centos8InstallCryptoUrl}.asc`}>asc</a>,&nbsp;
-                      <a href={`${centos8InstallCryptoUrl}.sha512`}>sha512</a>
+                      <a href={`${rocky8InstallCryptoUrl}.asc`}>asc</a>,&nbsp;
+                      <a href={`${rocky8InstallCryptoUrl}.sha512`}>sha512</a>
                     </td>
                   </tr>
                   <tr key={'debian10-install'}>
@@ -168,14 +168,14 @@ class Download extends React.Component {
                       <a href={`${debian10InstallCryptoUrl}.sha512`}>sha512</a>
                     </td>
                   </tr>
-                   <tr key={'ubuntu18.04-install'}>
-                    <th>Ubuntu18.04</th>
+                   <tr key={'ubuntu20.04-install'}>
+                    <th>Ubuntu20.04</th>
                     <td>
-                     <a href={`${ubuntu1804InstallUrl}`}> heron-install-0.20.4-incubating-ubuntu18.04.sh</a>
+                     <a href={`${ubuntu2004InstallUrl}`}> heron-install-0.20.4-incubating-ubuntu20.04.sh</a>
                     </td>
                     <td>
-                      <a href={`${ubuntu1804InstallCryptoUrl}.asc`}>asc</a>,&nbsp;
-                      <a href={`${ubuntu1804InstallCryptoUrl}.sha512`}>sha512</a>
+                      <a href={`${ubuntu2004InstallCryptoUrl}.asc`}>asc</a>,&nbsp;
+                      <a href={`${ubuntu2004InstallCryptoUrl}.sha512`}>sha512</a>
                     </td>
                   </tr>
                   </tbody>