Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 8 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
---
name: Bug report v1
about: Create a report to help us improve v1 operator
name: End support for v1
about: How To
labels: bug, v1
---

**Describe the bug**
A clear and concise description of what the bug is.
# What

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
In the summer of 2023, a new operator, v2, was released with enhanced support for ODH.
For more details, please refer to the blog post: [ODH Operator v2.0 Blog]([https://opendatahub.io/blog/2023-07-24-odh-operator-v2.0-blog/)

**Expected behavior**
A clear and concise description of what you expected to happen.
During the autumn of 2023, the project decided to end the support period for ODH operator v1. The release version v1.11.0 marks the final release for operator v1; thereafter, v2.4.0 takes over. Consequently, no new feature developments or bug fixes will be pursued for v1.

**Screenshots**
If applicable, add screenshots to help explain your problem.
# How

**Additional context**
Add any other context about the problem here.
We strongly recommend you switch from v1 to v2, see upgrade blog: https://opendatahub.io/docs/upgrading-open-data-hub/#upgrading-the-odh-operator-v1_upgradev
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_reportv2.md

This file was deleted.

48 changes: 37 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,43 @@
---
name: Feature request
about: Suggest an idea for this project
labels: enhancement
name: New way to report issue on Operator v2
about: How To
labels: feature, enhancement, bug, v2
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Updates**

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
In the winter of 2023, we transitioned GitHub Issues to the Red Hat Jira issue board located at https://issues.redhat.com.
Moving forward, kindly utilize this platform for reporting any new issues.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
All previous issues from GitHub have been seamlessly migrated to the issue board, accompanied by a link directing users to the corresponding old issues for follow-up.

**Additional context**
Add any other context or screenshots about the feature request here.
**How To**

- Login Jira issue board https://issues.redhat.com
- Click "Create" on top
- Choose: "Project 'Red Hat Openshift Data Science'"
- Issue Type:
- if it is a bug, choose "Bug"
- if it is a new feature requirement, choose "Feature"
- if it is an enhancement work, choose "Task"
- Fill in "Summary" with a clear and concise description of what the ticket is.
- Add "Description" with detail information, see below:
- Describe the bug***
- on which branch, bug is observed:
- has it worked before/ in which version it starts breaking:
- etc
- Steps to reproduce the behavior if it is a "Bug" type:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- Expected behavior: a clear and concise description of what you expect to happen.
- Additional context: Add any other context about the ticket here.
- Choose: "Components/s: 'Platform'"
- Attachment: if applicable, upload screenshots to help explain more.

**Troubleshooting**

- If you do not have Red Hat account, you will need to create one for the first time to log in to the Jira issue board.
- If you are unsure about certain fields when creating an issue ticket, you can leave them blank.
- If you encounter any blocker despite your efforts, feel free to use GitHub Issue. We will assist you in mirroring GitHub issues to the issue board. Please note that this approach may take longer than creating a Jira ticket directly in the issue board.
24 changes: 0 additions & 24 deletions .github/workflows/auto_add_issues.yaml

This file was deleted.

44 changes: 44 additions & 0 deletions .github/workflows/check-file-updates.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Check config and readme updates
on:
pull_request:
jobs:
file-updates:
permissions:
pull-requests: write
name: Ensure generated files are included
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Generate files
id: generate-files
run: |
CMD="make generate manifests api-docs"
$CMD
echo "CMD=$CMD" >> $GITHUB_OUTPUT
- name: Ensure generated files are up-to-date
id: check_generated_files
run : |
if [[ -n $(git status -s) ]]
then
echo "Generated files have been missed in the PR"
git diff
echo "missing_generated_files=true" >> $GITHUB_OUTPUT
else
echo "No new files to commit"
echo "missing_generated_files=false" >> $GITHUB_OUTPUT
fi
- name: Report issue in PR
if: ${{ steps.check_generated_files.outputs.missing_generated_files == 'true' }}
uses: thollander/actions-comment-pull-request@v2
with:
message: |
## This PR can't be merged just yet 😢

Please run `${{ steps.generate-files.outputs.CMD }}` and commit the changes.

For more info: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
- name: Print git status and fail pr
if: ${{ steps.check_generated_files.outputs.missing_generated_files == 'true' }}
run: |
git status
exit 1
16 changes: 3 additions & 13 deletions .github/workflows/linter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,14 @@ jobs:
golangci:
name: golangci-lint
runs-on: ubuntu-latest
env:
REPOSITORY: go/src/github.com/${{ github.repository }}
steps:
- uses: actions/checkout@v4
with:
path: ${{ env.REPOSITORY }}
- name: Set up Go env
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version-file: ${{ env.REPOSITORY }}/go.mod
- name: Set $GOPATH
run: |
echo "GOPATH=${{ github.workspace }}/go" >> $GITHUB_ENV
echo "${{ github.workspace }}/go/bin" >> $GITHUB_PATH
shell: bash
go-version-file: go.mod
- name: golangci-lint
uses: golangci/golangci-lint-action@v3
uses: golangci/golangci-lint-action@v4
with:
version: v1.54.0
working-directory: ${{ env.REPOSITORY }}
args: --timeout 5m0s
14 changes: 8 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ IMAGE_TAG_BASE ?= quay.io/opendatahub/opendatahub-operator
# keep the name based on IMG which already used from command line
IMG_TAG ?= latest
# Update IMG to a variable, to keep it consistent across versions for OpenShift CI
IMG = $(IMAGE_TAG_BASE):$(IMG_TAG)
IMG ?= $(IMAGE_TAG_BASE):$(IMG_TAG)
# BUNDLE_IMG defines the image:tag used for the bundle.
# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
Expand Down Expand Up @@ -72,7 +72,8 @@ OPERATOR_SDK_VERSION ?= v1.24.1
GOLANGCI_LINT_VERSION ?= v1.54.0
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.24.2
CRD_REF_DOCS_VERSION = 0.0.10
ENVTEST_PACKAGE_VERSION = v0.0.0-20240320141353-395cfc7486e6
CRD_REF_DOCS_VERSION = 0.0.11

# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
Expand Down Expand Up @@ -221,7 +222,7 @@ deploy: prepare ## Deploy controller to the K8s cluster specified in ~/.kube/con
$(KUSTOMIZE) build config/default | kubectl apply --namespace $(OPERATOR_NAMESPACE) -f -

.PHONY: undeploy
undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
undeploy: prepare ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -

## Location to install dependencies to
Expand Down Expand Up @@ -254,7 +255,7 @@ GOLANGCI_LINT_INSTALL_SCRIPT ?= 'https://raw.githubusercontent.com/golangci/gola
.PHONY: golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT): $(LOCALBIN)
test -s $(LOCALBIN)/golangci-lint || { curl -sSfL $(GOLANGCI_LINT_INSTALL_SCRIPT) | bash -s $(GOLANGCI_LINT_VERSION); }
test -s $(GOLANGCI_LINT) || { curl -sSfL $(GOLANGCI_LINT_INSTALL_SCRIPT) | bash -s $(GOLANGCI_LINT_VERSION); }

CRD_REF_DOCS_DL_URL ?= 'https://github.com/elastic/crd-ref-docs/releases/download/v$(CRD_REF_DOCS_VERSION)/crd-ref-docs'
.PHONY: crd-ref-docs
Expand Down Expand Up @@ -344,7 +345,7 @@ TEST_SRC=./controllers/... ./tests/integration/features/... ./pkg/feature/...
.PHONY: envtest
envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST): $(LOCALBIN)
test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
test -s $(ENVTEST) || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@$(ENVTEST_PACKAGE_VERSION)

.PHONY: test
test: unit-test e2e-test
Expand All @@ -358,6 +359,7 @@ CLEANFILES += cover.out
e2e-test: ## Run e2e tests for the controller
go test ./tests/e2e/ -run ^TestOdhOperator -v --operator-namespace=${OPERATOR_NAMESPACE} ${E2E_TEST_FLAGS}

clean:
clean: $(GOLANGCI_LINT)
$(GOLANGCI_LINT) cache clean
chmod u+w -R $(LOCALBIN) # envtest makes its dir RO
rm -rf $(CLEANFILES)
Loading