diff --git a/.github/workflows/check-md-link.yml b/.github/workflows/check-md-link.yml index 88c6f49ae4..7e57f29524 100644 --- a/.github/workflows/check-md-link.yml +++ b/.github/workflows/check-md-link.yml @@ -41,5 +41,5 @@ jobs: with: use-quiet-mode: 'yes' config-file: '.github/workflows/check-md-link-config.json' - folder-path: 'regtests, .github, build-logic, polaris-core, service, runtime, persistence, spec, k8, getting-started, helm' + folder-path: 'regtests, .github, build-logic, polaris-core, service, runtime, persistence, spec, getting-started, helm' file-path: 'CHAT_BYLAWS.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, README.md, SECURITY.md' diff --git a/README.md b/README.md index 81fa99518a..20b6604742 100644 --- a/README.md +++ b/README.md @@ -99,16 +99,7 @@ using different configurations. Check the `./getting-started` directory for more #### Running in Kubernetes -- `./run.sh` - To run Polaris as a mini-deployment locally. This will create a Kind cluster, - then deploy one pod and one service. The service is available on ports `8181` and `8182`. -- `kubectl port-forward svc/polaris-service -n polaris 8181:8181 8182:8182` - To create secure - connections between a local machine and a pod within the cluster for both service and - health/metrics endpoints: - - http://localhost:8182/q/metrics - - http://localhost:8182/q/health -- `kubectl get pods -n polaris` - To check the status of the pods. -- `kubectl get deployment -n polaris` - To check the status of the deployment. -- `kubectl describe deployment polaris-deployment -n polaris` - To troubleshoot if things aren't working as expected. +- See [README in `helm/polaris`](helm/polaris/README.md) for more information. #### Configuring Polaris diff --git a/helm/polaris/README.md b/helm/polaris/README.md index 2cf8ae307d..b649641df5 100644 --- a/helm/polaris/README.md +++ b/helm/polaris/README.md @@ -42,20 +42,6 @@ A Helm chart for Apache Polaris (incubating). ## Installation -### Running locally with a Kind cluster - -The below instructions assume Kind and Helm are installed. - -Simply run the `run.sh` script from the Polaris repo root: - -```bash -./run.sh -``` - -This script will create a Kind cluster, deploy a local Docker registry, build the Polaris Docker -images with support for Postgres and load them into the Kind cluster. (It will also create an -example Deployment and Service with in-memory storage.) - ### Running locally with a Minikube cluster The below instructions assume Minikube and Helm are installed. @@ -108,15 +94,6 @@ helm upgrade --install --namespace polaris \ polaris helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `helm upgrade` as follows: -```bash -helm upgrade --install --namespace polaris \ - --values helm/polaris/ci/simple-values.yaml \ - --set=image.repository=localhost:5001/apache/polaris \ - polaris helm/polaris -``` - #### Persistent backend > [!WARNING] @@ -208,14 +185,6 @@ Integration tests are run with the Chart Testing tool: ct install --namespace polaris --charts ./helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `ct install` as follows: - -```bash -ct install --namespace polaris --debug --charts ./helm/polaris \ - --helm-extra-set-args "--set=image.repository=localhost:5001/apache/polaris" -``` - ## Values | Key | Type | Default | Description | diff --git a/helm/polaris/README.md.gotmpl b/helm/polaris/README.md.gotmpl index 293403a867..277ff4b830 100644 --- a/helm/polaris/README.md.gotmpl +++ b/helm/polaris/README.md.gotmpl @@ -44,20 +44,6 @@ weight: 675 ## Installation -### Running locally with a Kind cluster - -The below instructions assume Kind and Helm are installed. - -Simply run the `run.sh` script from the Polaris repo root: - -```bash -./run.sh -``` - -This script will create a Kind cluster, deploy a local Docker registry, build the Polaris Docker -images with support for Postgres and load them into the Kind cluster. (It will also create an -example Deployment and Service with in-memory storage.) - ### Running locally with a Minikube cluster The below instructions assume Minikube and Helm are installed. @@ -110,15 +96,6 @@ helm upgrade --install --namespace polaris \ polaris helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `helm upgrade` as follows: -```bash -helm upgrade --install --namespace polaris \ - --values helm/polaris/ci/simple-values.yaml \ - --set=image.repository=localhost:5001/apache/polaris \ - polaris helm/polaris -``` - #### Persistent backend > [!WARNING] @@ -210,12 +187,4 @@ Integration tests are run with the Chart Testing tool: ct install --namespace polaris --charts ./helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `ct install` as follows: - -```bash -ct install --namespace polaris --debug --charts ./helm/polaris \ - --helm-extra-set-args "--set=image.repository=localhost:5001/apache/polaris" -``` - {{ template "chart.valuesSection" . }} diff --git a/k8/deployment.yaml b/k8/deployment.yaml deleted file mode 100644 index 4d30fda577..0000000000 --- a/k8/deployment.yaml +++ /dev/null @@ -1,61 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -apiVersion: v1 -kind: Namespace -metadata: - name: polaris ---- -apiVersion: apps/v1 -kind: Deployment -metadata: - name: polaris-deployment - namespace: polaris -spec: - replicas: 1 - selector: - matchLabels: - app: polaris - template: - metadata: - labels: - app: polaris - spec: - containers: - - name: polaris - image: localhost:5001/apache/polaris:latest - ports: - - containerPort: 8181 - - containerPort: 8182 ---- -apiVersion: v1 -kind: Service -metadata: - name: polaris-service - namespace: polaris -spec: - selector: - app: polaris - ports: - - name: service - port: 8181 - targetPort: 8181 - - name: metrics - port: 8182 - targetPort: 8182 diff --git a/run.sh b/run.sh deleted file mode 100755 index 3d5c17fc3a..0000000000 --- a/run.sh +++ /dev/null @@ -1,67 +0,0 @@ -#!/bin/bash - -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -# Runs Polaris as a mini-deployment locally. Creates two pods that bind themselves to port 8181. - -# Function to display usage information -usage() { - echo "Usage: $0 [--eclipse-link-deps=] [-h|--help]" - echo " -h, --help Display this help message" - exit 1 -} - -# Parse command-line arguments -while [[ "$#" -gt 0 ]]; do - case $1 in - -h|--help) - usage - ;; - *) - usage - ;; - esac - shift -done - -# Deploy the registry -echo "Building Kind Registry..." -sh ./kind-registry.sh - -# Build and deploy the server image -echo "Building polaris image..." -./gradlew \ - :polaris-server:assemble \ - :polaris-server:quarkusAppPartsBuild --rerun \ - :polaris-admin:assemble \ - :polaris-admin:quarkusAppPartsBuild --rerun \ - -Dquarkus.container-image.tag=postgres-latest \ - -Dquarkus.container-image.build=true \ - -Dquarkus.container-image.registry=localhost:5001 - -echo "Pushing polaris image..." -docker push localhost:5001/apache/polaris - -echo "Loading polaris image to kind..." -kind load docker-image localhost:5001/apache/polaris:latest - -echo "Applying kubernetes manifests..." -kubectl delete -f k8/deployment.yaml --ignore-not-found -kubectl apply -f k8/deployment.yaml diff --git a/site/content/in-dev/unreleased/helm.md b/site/content/in-dev/unreleased/helm.md index 2cf8ae307d..b649641df5 100644 --- a/site/content/in-dev/unreleased/helm.md +++ b/site/content/in-dev/unreleased/helm.md @@ -42,20 +42,6 @@ A Helm chart for Apache Polaris (incubating). ## Installation -### Running locally with a Kind cluster - -The below instructions assume Kind and Helm are installed. - -Simply run the `run.sh` script from the Polaris repo root: - -```bash -./run.sh -``` - -This script will create a Kind cluster, deploy a local Docker registry, build the Polaris Docker -images with support for Postgres and load them into the Kind cluster. (It will also create an -example Deployment and Service with in-memory storage.) - ### Running locally with a Minikube cluster The below instructions assume Minikube and Helm are installed. @@ -108,15 +94,6 @@ helm upgrade --install --namespace polaris \ polaris helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `helm upgrade` as follows: -```bash -helm upgrade --install --namespace polaris \ - --values helm/polaris/ci/simple-values.yaml \ - --set=image.repository=localhost:5001/apache/polaris \ - polaris helm/polaris -``` - #### Persistent backend > [!WARNING] @@ -208,14 +185,6 @@ Integration tests are run with the Chart Testing tool: ct install --namespace polaris --charts ./helm/polaris ``` -Note: if you are running the tests on a Kind cluster started with the `run.sh` command explained -above, then you need to run `ct install` as follows: - -```bash -ct install --namespace polaris --debug --charts ./helm/polaris \ - --helm-extra-set-args "--set=image.repository=localhost:5001/apache/polaris" -``` - ## Values | Key | Type | Default | Description |