chore: clean up stale LogicPlatform references after ClusterLogicPlatform rename

Open Beginner friendly
#105 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
79/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
go, kubernetes
Domain
devops

Research direction

Read the PROJECT resource entry and the named comments in api/v1/platform_types.go and api/v1/status_types.go; check api/v1/clusterlogicplatform_types.go for the cluster scope marker. Update the stale resource name, scope, and comment references, then run make generate manifests and confirm it produces no unexpected diff.

Written by the indexing model from the issue text.

Description

documentation good first issue

After #89 replaced LogicPlatform with ClusterLogicPlatform, a few references to the old name and field paths were left behind.

Inconsistencies

1. PROJECT still lists LogicPlatform
  • PROJECT has a resource entry with kind: LogicPlatform and namespaced: true.
  • There is no entry for `ClusterLogicPlatform`, which is cluster-scoped (`+kubebuilder:resource:scope=Cluster` in api/v1/clusterlogicplatform_types.go).

Fix: Replace the entry with kind: ClusterLogicPlatform and namespaced: false.

2. Stale comments in api/v1/platform_types.go
  • L65: The DaemonSet is deployed 1:1 per LogicPlatform ...
  • L228: There is a 1:1 relationship between LogicPlatform and the Vector DaemonSet.
  • L298: Populated only when spec.workflowGateway.ingress.enabled .... The field is spec.gateway (`json:"gateway"`).
3. Stale comments in `api/v1/status_types.go`
  • L62: // LogicPlatform conditions
  • L74: // LogicPlatform reasons

Acceptance criteria

  • PROJECT describes ClusterLogicPlatform\ as a cluster-scoped resource
  • No comments under api/ refer to LogicPlatform (other than ClusterLogicPlatform) or spec.workflowGateway
  • make generate manifests produces no unexpected diff
Dominant language
Go
Stars
3
Forks
3
Avg merge
1d 12m
Merged PRs (30d)
18

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from kubesmarts/logic-operator

All issues in kubesmarts/logic-operator

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.