Remove legacy CLI, code, and scaffold templates #3385

joelanford · 2020-07-10T16:57:36Z

Description of the change:
Removes:

Motivation for the change:
Remove legacy code in preparation for 1.0 release

Checklist

If the pull request includes user-facing changes, extra documentation is required:

Add a new changelog fragment in changelog/fragments (see changelog/fragments/00-template.yaml)
Add or update relevant sections of the docs website in website/content/en/docs

…e kind

jmrodri

remove migrate subcommand and scaffolds
+1 nicely done
remove print-deps and go.mod template
+1
remove legacy go init templates
+1
remove add subscommands for legacy Go projects
+1 quite a bit of code being removed!
internal/scaffod: remove more unused code
+1 love seeing dead code go away
remove legacy scorecard
+1
go mod tidy
+1
remove legacy go e2e tests
+1
remove legacy e2e tests, rename e2e-new, don't require kind
+1 to not requiring kind
remove more unused code
+1
don't run removed generate k8s
+1
remove crds subcommand
+1
remove version checks for go-mod templates
+1 nicely done

jmrodri · 2020-07-11T00:59:45Z

internal/scaffold/tools_test.go

-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package scaffold


one of my tests is going bye bye 😭

jmrodri · 2020-07-11T01:02:23Z

.travis.yml

-    # Build and deploy arm64 scorecard-proxy docker image
-    - <<: *deploy
-      name: Docker image for scorecard-proxy (arm64)
-      arch: arm64
-      script:
-        - make image-build-scorecard-proxy
-        - make image-push-scorecard-proxy
-
-    # Build and deploy amd64 scorecard-proxy docker image
-    - <<: *deploy
-      name: Docker image for scorecard-proxy (amd64)
-      arch: amd64
-      script:
-        - make image-build-scorecard-proxy
-        - make image-push-scorecard-proxy
-
-    # Build and deploy ppc64le scorecard-proxy docker image
-    - <<: *deploy
-      name: Docker image for scorecard-proxy (ppc64le)
-      arch: ppc64le
-      script:
-        - make image-build-scorecard-proxy
-        - make image-push-scorecard-proxy
-
-    # Build and deploy s390x scorecard-proxy docker image
-    - <<: *deploy
-      name: Docker image for scorecard-proxy (s390x)
-      arch: s390x
-      script:
-        - make image-build-scorecard-proxy
-        - make image-push-scorecard-proxy
-


❤️ That's one less set of images to fail during a build :)

but do you not need these images? Pinging @jmccormick2001 who is their father just for we sure if it is fine.

the scorecard-proxy is not used in the new scorecard so its fine to remove.

jmrodri · 2020-07-11T01:03:31Z

go.mod

 	github.com/onsi/ginkgo v1.12.0
 	github.com/onsi/gomega v1.9.0
 	github.com/operator-framework/api v0.3.8
 	github.com/operator-framework/operator-registry v1.12.6-0.20200611222234-275301b779f8
 	github.com/pborman/uuid v1.2.0
-	github.com/pkg/errors v0.9.1


Surprising this must have been used only in a few places.

jmrodri · 2020-07-11T01:05:58Z

Makefile

 test-e2e-go:
-	./hack/tests/e2e-go.sh $(ARGS)
-
-test-e2e-go-new:
-	K8S_VERSION=$(K8S_VERSION) ./hack/tests/e2e-go-new.sh
+	K8S_VERSION=$(K8S_VERSION) ./hack/tests/e2e-go.sh



+1 made sure the targets were repurposed.

jmrodri · 2020-07-11T01:08:30Z

hack/generate/test-framework/gen-test-framework.sh

@@ -18,5 +18,4 @@ go build ./...
 go mod tidy

 # Run gen commands
-../../build/operator-sdk generate k8s


jmrodri · 2020-07-11T01:09:25Z

release.sh

-GO_GOMOD="internal/scaffold/go_mod.go"
-ANS_GOMOD="internal/scaffold/ansible/go_mod.go"
-HELM_GOMOD="internal/scaffold/helm/go_mod.go"
-CURR_VER_GO_GOMOD="$(sed -E -n -r 's|.*operator-sdk ([^ \t\n]+).*|\1|p' "$GO_GOMOD" | tail -1 | tr -d ' \t\n')"
-if [[ "$VER" != "$CURR_VER_GO_GOMOD" ]]; then
-	echo "go.mod 'replace' entry version is not set correctly in $GO_GOMOD"
-	exit 1
-fi
-CURR_VER_ANS_GOMOD="$(sed -E -n -r 's|.*operator-sdk ([^ \t\n]+).*|\1|p' "$ANS_GOMOD" | tail -1 | tr -d ' \t\n')"
-if [[ "$VER" != "$CURR_VER_ANS_GOMOD" ]]; then
-	echo "go.mod 'replace' entry version is not set correctly in $ANS_GOMOD"
-	exit 1
-fi
-CURR_VER_HELM_GOMOD="$(sed -E -n -r 's|.*operator-sdk ([^ \t\n]+).*|\1|p' "$HELM_GOMOD" | tail -1 | tr -d ' \t\n')"
-if [[ "$VER" != "$CURR_VER_HELM_GOMOD" ]]; then
-	echo "go.mod 'replace' entry version is not set correctly in $HELM_GOMOD"
-	exit 1
-fi
-


Nicely done

jmrodri · 2020-07-11T01:10:18Z

/lgtm

camilamacedo86 · 2020-07-11T17:10:47Z

.travis.yml

@@ -51,9 +51,9 @@ x_base_steps:
      - make setup-k8s
      - export KUBECONFIG="$(kind get kubeconfig-path --name="kind")"
    after_success:
-      - echo "Build succeeded, operator was generated, memcached operator is running on $CLUSTER, and unit/integration tests pass"
+      - echo "Tests passed"


camilamacedo86 · 2020-07-11T17:13:31Z

go.mod

@@ -13,13 +13,11 @@ require (
 	github.com/markbates/inflect v1.0.4
 	github.com/mattn/go-isatty v0.0.12
 	github.com/mitchellh/go-homedir v1.1.0
-	github.com/mitchellh/mapstructure v1.1.2


camilamacedo86 · 2020-07-11T17:20:18Z

internal/scaffold/constants.go

+
+	// files
+	DockerfileFile   = "Dockerfile"
+	OperatorYamlFile = "operator.yaml"


we will be able to remove the vars related to the legacy layout. However, it is not in the scope of this pr.

camilamacedo86

Great 👍
/lgtm
/approve

estroz

/lgtm

drewwells · 2020-09-02T03:46:32Z

For the record, I just started using this project 2 months ago and the CLI has completely changed and there was no upgrade path offered in the cli itself. This is a major letdown as a user. We have a scaffolding tool for our internal projects and it suffers the same issues with upgrades. Scaffolding may not be the best way to offer general purpose toolkits for people to build projects on.

estroz · 2020-09-02T08:28:27Z

@drewwells I’m sorry to hear that we’ve let you down. We do not enjoy breaking things for users, and didn’t make the decision to do so lightly.

I and many other SDK contributors felt these changes necessary to improve maintainability of scaffolded projects and be better tenants of the k8s community (ex. align with kubebuilder’s scaffolds, use kustomize extensively). Going forward we will not make any breaking changes to operator-sdk’s CLI or project scaffolds in any minor release, and do not plan on making drastic CLI changes in the next major release (which is still far off to begin with).

Unfortunately it isn’t feasible to write a full migration tool due to the complexity of these changes. However we do have a migration guide that covers migrating both CLI and projects to their v1 states. Feel free to open issues for specific questions about the new CLI/project layout too!

drewwells · 2020-09-08T14:58:31Z

Thanks for the acknowledgement. We've started the migration and it has gone well. I'll try to find time to commit to the docs to help with some gotchas that I ran into. Thanks for the great work, it's been a great toolkit for us!

openshift-ci-robot requested review from fabianvf and theishshah July 10, 2020 16:57

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 10, 2020

joelanford added 8 commits July 10, 2020 13:00

cmd/operator-sdk: remove migrate subcommand and scaffolds

3e79f63

cmd/operator-sdk: remove print-deps and go.mod template

67bc3ae

internal/scaffold: remove legacy go init templates

1fbd318

remove add subcommands for legacy Go projects

3786848

internal/scaffold: remove more unused code

63a806f

cmd/operator-sdk: remove legacy scorecard

2bfe739

go.mod: run go mod tidy

ee7c754

hack/tests: remove legacy go e2e test

412cada

joelanford force-pushed the rm-legacy-go branch from 488fb78 to ad546ce Compare July 10, 2020 17:01

openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 10, 2020

joelanford added 4 commits July 10, 2020 14:43

test/e2e: remove legacy e2e test, rename e2e-new to e2e, don't requir…

a33d669

…e kind

*: remove more unused/unnecessary legacy code

588b954

gen-test-framework: don't run removed generate k8s

23d3fb5

cmd/operator-sdk/generate: remove crds subcommand

38d3e26

joelanford force-pushed the rm-legacy-go branch from ad546ce to 38d3e26 Compare July 10, 2020 18:47

joelanford changed the title ~~WIP: Remove legacy CLI, code, and scaffold templates~~ Remove legacy CLI, code, and scaffold templates Jul 10, 2020

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 10, 2020

joelanford mentioned this pull request Jul 10, 2020

Operator SDK 1.0 Meta-issue #3327

Closed

92 tasks

release.sh: remove version checks for non-existent go.mod templates

099df04

joelanford added this to the v1.0.0 milestone Jul 10, 2020

jmrodri approved these changes Jul 11, 2020

View reviewed changes

openshift-ci-robot assigned jmrodri Jul 11, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 11, 2020

camilamacedo86 reviewed Jul 11, 2020

View reviewed changes

camilamacedo86 approved these changes Jul 11, 2020

View reviewed changes

openshift-ci-robot assigned camilamacedo86 Jul 11, 2020

estroz approved these changes Jul 13, 2020

View reviewed changes

openshift-ci-robot assigned estroz Jul 13, 2020

joelanford merged commit 53c0f35 into operator-framework:master Jul 13, 2020

joelanford deleted the rm-legacy-go branch July 13, 2020 19:57

This was referenced Jul 13, 2020

cmd/operator-sdk/run: remove legacy run subcommand #3406

Merged

changelog/fragments: add rm-legacy-go.yaml and rm-legacy-run.yaml #3416

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove legacy CLI, code, and scaffold templates #3385

Remove legacy CLI, code, and scaffold templates #3385

joelanford commented Jul 10, 2020 •

edited

Loading

jmrodri left a comment

jmrodri Jul 11, 2020

jmrodri Jul 11, 2020

camilamacedo86 Jul 11, 2020 •

edited

Loading

jmccormick2001 Jul 14, 2020

jmrodri Jul 11, 2020

jmrodri Jul 11, 2020

jmrodri Jul 11, 2020

jmrodri Jul 11, 2020

jmrodri commented Jul 11, 2020

camilamacedo86 Jul 11, 2020

camilamacedo86 Jul 11, 2020

camilamacedo86 Jul 11, 2020

camilamacedo86 left a comment

estroz left a comment

drewwells commented Sep 2, 2020

estroz commented Sep 2, 2020

drewwells commented Sep 8, 2020

Remove legacy CLI, code, and scaffold templates #3385

Remove legacy CLI, code, and scaffold templates #3385

Conversation

joelanford commented Jul 10, 2020 • edited Loading

jmrodri left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Jul 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmrodri commented Jul 11, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

drewwells commented Sep 2, 2020

estroz commented Sep 2, 2020

drewwells commented Sep 8, 2020

joelanford commented Jul 10, 2020 •

edited

Loading

camilamacedo86 Jul 11, 2020 •

edited

Loading