Skip to content

Commit 3aedf4b

Browse files
authored
Reorganize Porch packages (#3069)
* align closer with canonical golang repository structure * remove hack directory * remove unnecessary directory nesting (`engine/pkg/`, `repository/pkg/`)
1 parent 7aea11e commit 3aedf4b

File tree

196 files changed

+112
-155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+112
-155
lines changed

.github/workflows/porch-e2e.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,6 @@ jobs:
9696
done
9797
- name: e2e test
9898
run: go test -v .
99-
working-directory: ./porch/apiserver/pkg/e2e
99+
working-directory: ./porch/test/e2e
100100
- name: Porch CLI e2e test
101101
run: make test-porch

.github/workflows/porch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- name: Run Porch Unit Tests
3737
uses: actions/checkout@v2
3838
- name: Verify format / headers etc
39-
run: hack/verify-fix-all.sh
39+
run: scripts/verify-fix-all.sh
4040
working-directory: ./porch
4141
- name: Build
4242
run: make porch

porch/.vscode/launch.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
"type": "go",
2121
"request": "launch",
2222
"mode": "auto",
23-
"program": "${workspaceFolder}/apiserver/cmd/porch/main.go",
23+
"program": "${workspaceFolder}/cmd/porch/main.go",
2424
"args": [
2525
"--secure-port=9443",
2626
"--v=7",
2727
"--standalone-debug-mode",
28-
"--kubeconfig=${workspaceFolder}/hack/local/kubeconfig",
28+
"--kubeconfig=${workspaceFolder}/deployments/local/kubeconfig",
2929
"--cache-directory=${workspaceFolder}/.cache",
3030
"--function-runner=192.168.8.202:9445"
3131
],

porch/Makefile

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,16 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
KUBECONFIG=$(CURDIR)/hack/local/kubeconfig
15+
KUBECONFIG=$(CURDIR)/deployments/local/kubeconfig
1616
BUILDDIR=$(CURDIR)/.build
1717
CACHEDIR=$(CURDIR)/.cache
1818
DEPLOYCONFIGDIR=$(BUILDDIR)/deploy
1919
DEPLOYCONFIG_NO_SA_DIR=$(BUILDDIR)/deploy-no-sa
20+
KPTDIR=$(abspath $(CURDIR)/..)
2021

2122
# Modules are ordered in dependency order. A module precedes modules that depend on it.
2223
MODULES = \
23-
config/samples/apps/hello-server \
24+
examples/apps/hello-server \
2425
api \
2526
. \
2627

@@ -54,7 +55,7 @@ stop:
5455

5556
.PHONY: start-etcd
5657
start-etcd:
57-
docker buildx build -t etcd --output=type=docker hack/local/etcd
58+
docker buildx build -t etcd --output=type=docker -f ./build/Dockerfile.etcd ./build
5859
mkdir -p $(BUILDDIR)/data/etcd
5960
docker stop etcd || true
6061
docker rm etcd || true
@@ -66,10 +67,10 @@ start-etcd:
6667

6768
.PHONY: start-kube-apiserver
6869
start-kube-apiserver:
69-
docker buildx build -t kube-apiserver --output=type=docker hack/local/kube-apiserver
70+
docker buildx build -t kube-apiserver --output=type=docker -f ./build/Dockerfile.apiserver ./build
7071
docker stop kube-apiserver || true
7172
docker rm kube-apiserver || true
72-
hack/local/makekeys.sh
73+
deployments/local/makekeys.sh
7374
docker run --detach --user `id -u`:`id -g` \
7475
--network=porch \
7576
--ip 192.168.8.201 \
@@ -123,7 +124,7 @@ PORCH = $(BUILDDIR)/porch
123124

124125
.PHONY: run-local
125126
run-local: porch
126-
KUBECONFIG=$(KUBECONFIG) kubectl apply -f hack/local/localconfig.yaml
127+
KUBECONFIG=$(KUBECONFIG) kubectl apply -f deployments/local/localconfig.yaml
127128
KUBECONFIG=$(KUBECONFIG) kubectl apply -f api/porchconfig/v1alpha1/
128129
$(PORCH) \
129130
--secure-port 9443 \
@@ -138,7 +139,7 @@ run-jaeger:
138139

139140
.PHONY: porch
140141
porch:
141-
cd apiserver; go build -o $(PORCH) ./cmd/porch
142+
go build -o $(PORCH) ./cmd/porch
142143

143144
.PHONY: fix-headers
144145
fix-headers:
@@ -150,14 +151,14 @@ fix-all: fix-headers fmt tidy
150151

151152
.PHONY: push-images
152153
push-images:
153-
IMAGE_NAME="$(PORCH_SERVER_IMAGE)" make -C apiserver/ push-image
154+
docker buildx build --push --tag $(IMAGE_REPO)/$(PORCH_SERVER_IMAGE):$(IMAGE_TAG) -f ./build/Dockerfile.porch "$(KPTDIR)"
154155
IMAGE_NAME="$(PORCH_CONTROLLERS_IMAGE)" make -C controllers/ push-image
155156
IMAGE_NAME="$(PORCH_FUNCTION_RUNNER_IMAGE)" WRAPPER_SERVER_IMAGE_NAME="$(PORCH_WRAPPER_SERVER_IMAGE)" make -C func/ push-image
156157
IMAGE_NAME="$(TEST_GIT_SERVER_IMAGE)" make -C test/ push-image
157158

158159
.PHONY: build-images
159160
build-images:
160-
IMAGE_NAME="$(PORCH_SERVER_IMAGE)" make -C apiserver/ build-image
161+
docker buildx build --load --tag $(IMAGE_REPO)/$(PORCH_SERVER_IMAGE):$(IMAGE_TAG) -f ./build/Dockerfile.porch "$(KPTDIR)"
161162
IMAGE_NAME="$(PORCH_CONTROLLERS_IMAGE)" make -C controllers/ build-image
162163
IMAGE_NAME="$(PORCH_FUNCTION_RUNNER_IMAGE)" WRAPPER_SERVER_IMAGE_NAME="$(PORCH_WRAPPER_SERVER_IMAGE)" make -C func/ build-image
163164
IMAGE_NAME="$(TEST_GIT_SERVER_IMAGE)" make -C test/ build-image
@@ -182,7 +183,7 @@ apply-dev-config:
182183
deployment-config:
183184
rm -rf $(DEPLOYCONFIGDIR) || true
184185
mkdir -p $(DEPLOYCONFIGDIR)
185-
./hack/create-deployment-blueprint.sh \
186+
./scripts/create-deployment-blueprint.sh \
186187
--destination "$(DEPLOYCONFIGDIR)" \
187188
--server-image "$(IMAGE_REPO)/$(PORCH_SERVER_IMAGE):$(IMAGE_TAG)" \
188189
--controllers-image "$(IMAGE_REPO)/$(PORCH_CONTROLLERS_IMAGE):$(IMAGE_TAG)" \
@@ -207,7 +208,7 @@ push-and-deploy: push-images deploy
207208
deployment-config-no-sa:
208209
rm -rf $(DEPLOYCONFIG_NO_SA_DIR) || true
209210
mkdir -p $(DEPLOYCONFIG_NO_SA_DIR)
210-
./hack/create-deployment-blueprint.sh \
211+
./scripts/create-deployment-blueprint.sh \
211212
--destination "$(DEPLOYCONFIG_NO_SA_DIR)" \
212213
--server-image "$(IMAGE_REPO)/$(PORCH_SERVER_IMAGE):$(IMAGE_TAG)" \
213214
--controllers-image "$(IMAGE_REPO)/$(PORCH_CONTROLLERS_IMAGE):$(IMAGE_TAG)" \

porch/README.md

Lines changed: 1 addition & 1 deletion

porch/api/porch/doc.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
//go:generate go run k8s.io/code-generator/cmd/deepcopy-gen --input-dirs ./... -O zz_generated.deepcopy --go-header-file ../../hack/boilerplate.go.txt
16-
//go:generate go run k8s.io/code-generator/cmd/openapi-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --input-dirs k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/apimachinery/pkg/runtime,k8s.io/apimachinery/pkg/version --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/openapi -O zz_generated.openapi --go-header-file ../../hack/boilerplate.go.txt
15+
//go:generate go run k8s.io/code-generator/cmd/deepcopy-gen --input-dirs ./... -O zz_generated.deepcopy --go-header-file ../../scripts/boilerplate.go.txt
16+
//go:generate go run k8s.io/code-generator/cmd/openapi-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --input-dirs k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/apimachinery/pkg/runtime,k8s.io/apimachinery/pkg/version --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/openapi -O zz_generated.openapi --go-header-file ../../scripts/boilerplate.go.txt
1717

1818
// +k8s:deepcopy-gen=package,register
1919
// +groupName=porch.kpt.dev

porch/api/porch/v1alpha1/doc.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
//go:generate go run k8s.io/code-generator/cmd/deepcopy-gen --input-dirs ./ -O zz_generated.deepcopy --go-header-file ../../../hack/boilerplate.go.txt
16-
//go:generate go run k8s.io/code-generator/cmd/defaulter-gen --input-dirs ./ -O zz_generated.defaults --go-header-file ../../../hack/boilerplate.go.txt
17-
//go:generate go run k8s.io/code-generator/cmd/client-gen --clientset-name versioned --input-base "" --input github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/clientset --plural-exceptions PackageRevisionResources:PackageRevisionResources --go-header-file ../../../hack/boilerplate.go.txt
18-
//go:generate go run k8s.io/code-generator/cmd/lister-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/listers --go-header-file ../../../hack/boilerplate.go.txt
19-
//go:generate go run k8s.io/code-generator/cmd/informer-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --versioned-clientset-package github.com/GoogleContainerTools/kpt/porch/api/generated/clientset/versioned --listers-package github.com/GoogleContainerTools/kpt/porch/api/generated/listers --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/informers --plural-exceptions PackageRevisionResources:PackageRevisionResources --go-header-file ../../../hack/boilerplate.go.txt
20-
//go:generate go run k8s.io/code-generator/cmd/conversion-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch,github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 -O zz_generated.conversion --go-header-file ../../../hack/boilerplate.go.txt
15+
//go:generate go run k8s.io/code-generator/cmd/deepcopy-gen --input-dirs ./ -O zz_generated.deepcopy --go-header-file ../../../scripts/boilerplate.go.txt
16+
//go:generate go run k8s.io/code-generator/cmd/defaulter-gen --input-dirs ./ -O zz_generated.defaults --go-header-file ../../../scripts/boilerplate.go.txt
17+
//go:generate go run k8s.io/code-generator/cmd/client-gen --clientset-name versioned --input-base "" --input github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/clientset --plural-exceptions PackageRevisionResources:PackageRevisionResources --go-header-file ../../../scripts/boilerplate.go.txt
18+
//go:generate go run k8s.io/code-generator/cmd/lister-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/listers --go-header-file ../../../scripts/boilerplate.go.txt
19+
//go:generate go run k8s.io/code-generator/cmd/informer-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 --versioned-clientset-package github.com/GoogleContainerTools/kpt/porch/api/generated/clientset/versioned --listers-package github.com/GoogleContainerTools/kpt/porch/api/generated/listers --output-package github.com/GoogleContainerTools/kpt/porch/api/generated/informers --plural-exceptions PackageRevisionResources:PackageRevisionResources --go-header-file ../../../scripts/boilerplate.go.txt
20+
//go:generate go run k8s.io/code-generator/cmd/conversion-gen --input-dirs github.com/GoogleContainerTools/kpt/porch/api/porch,github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1 -O zz_generated.conversion --go-header-file ../../../scripts/boilerplate.go.txt
2121

2222
// Api versions allow the api contract for a resource to be changed while keeping
2323
// backward compatibility by support multiple concurrent versions

porch/api/porchconfig/v1alpha1/groupversion_info.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"k8s.io/apimachinery/pkg/runtime/schema"
2424
)
2525

26-
//go:generate go run sigs.k8s.io/controller-tools/cmd/[email protected] object object:headerFile="../../../hack/boilerplate.go.txt" crd:crdVersions=v1 output:crd:artifacts:config=. paths=./...
26+
//go:generate go run sigs.k8s.io/controller-tools/cmd/[email protected] object object:headerFile="../../../scripts/boilerplate.go.txt" crd:crdVersions=v1 output:crd:artifacts:config=. paths=./...
2727

2828
var (
2929
// GroupVersion is group version used to register these objects

porch/apiserver/Makefile

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)