Skip to content

Commit

Permalink
feat(*): new arch ๐ŸŒŸ๐ŸŒŸ๐ŸŒŸ๐ŸŒŸ
Browse files Browse the repository at this point in the history
  • Loading branch information
magicsong committed Oct 12, 2024
1 parent 5f760b4 commit 637c10f
Show file tree
Hide file tree
Showing 87 changed files with 6,039 additions and 542 deletions.
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
# Ignore build and test binaries.
bin/
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
vendor
.vscode# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
bin/*
Dockerfile.cross

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Go workspace file
go.work

# Kubernetes Generated files - skip generated files, except for vendored files
!vendor/**/zz_generated.*

# editor and IDE paraphernalia
.idea
.vscode
*.swp
*.swo
*~
.DS_Store
8 changes: 0 additions & 8 deletions .idea/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/misc.xml

This file was deleted.

8 changes: 0 additions & 8 deletions .idea/modules.xml

This file was deleted.

9 changes: 0 additions & 9 deletions .idea/okg-sidecar.iml

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/vcs.xml

This file was deleted.

69 changes: 33 additions & 36 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# ไฝฟ็”จAlpine LinuxไฝœไธบๅŸบ็ก€้•œๅƒ
FROM golang:1.22-alpine AS builder

# ่ฎพ็ฝฎๅทฅไฝœ็›ฎๅฝ•
WORKDIR /app

# ๅคๅˆถGoๆจกๅ—ๆ–‡ไปถ
COPY go.mod go.sum ./

# ๅคๅˆถๆบไปฃ็ 
COPY vendor vendor
COPY cmd cmd
COPY pkg pkg


# ๆž„ๅปบGoๅบ”็”จ
# ๆž„ๅปบGoๅบ”็”จ
RUN CGO_ENABLED=0 GOOS=linux go build -mod=vendor -o main cmd/main.go

# ไฝฟ็”จ่ฝป้‡็บง็š„Alpine Linuxไฝœไธบ่ฟ่กŒๆ—ถ้•œๅƒ
FROM alpine:3.15

# ๅฎ‰่ฃ…ๅฟ…่ฆ็š„ไพ่ต–้กน
RUN apk add --no-cache ca-certificates

# ่ฎพ็ฝฎๅทฅไฝœ็›ฎๅฝ•
WORKDIR /app

# ไปŽๆž„ๅปบ้˜ถๆฎตๅคๅˆถๅฏๆ‰ง่กŒๆ–‡ไปถ
COPY --from=builder /app/main .

# ๆšด้œฒ็ซฏๅฃ๏ผˆๅฆ‚ๆžœ้œ€่ฆ๏ผ‰
EXPOSE 8080

# ่ฟ่กŒๅบ”็”จ
CMD ["./main"]
# Build the manager binary
FROM golang:1.22 AS builder
ARG TARGETOS
ARG TARGETARCH

WORKDIR /workspace
# Copy the Go Modules manifests
COPY go.mod go.mod
COPY go.sum go.sum
# cache deps before building and copying source so that we don't need to re-download as much
# and so that source changes don't invalidate our downloaded layer
RUN go mod download

# Copy the go source
COPY cmd/main.go cmd/main.go
COPY api/ api/
COPY internal/controller/ internal/controller/
COPY pkg/ pkg/
# Build
# the GOARCH has not a default value to allow the binary be built according to the host where the command
# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go

# Use distroless as minimal base image to package the manager binary
# Refer to https://github.com/GoogleContainerTools/distroless for more details
FROM gcr.io/distroless/static:nonroot
WORKDIR /
COPY --from=builder /workspace/manager .
USER 65532:65532

ENTRYPOINT ["/manager"]
24 changes: 24 additions & 0 deletions PROJECT
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Code generated by tool. DO NOT EDIT.
# This file is used to track the info used to scaffold your project
# and allow the plugins properly work.
# More info: https://book.kubebuilder.io/reference/project-config.html
domain: vke.volcengine.com
layout:
- go.kubebuilder.io/v4
projectName: kidecar
repo: github.com/magicsong/kidecar
resources:
- api:
crdVersion: v1
namespaced: true
controller: true
domain: vke.volcengine.com
group: serverless
kind: SidecarConfig
path: github.com/magicsong/kidecar/api/v1alpha1
version: v1alpha1
webhooks:
defaulting: true
validation: true
webhookVersion: v1
version: "3"
119 changes: 113 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,114 @@
# okg-sidecar
sidecar for open kruise
# kidecar
// TODO(user): Add simple overview of use/purpose

## Description
// TODO(user): An in-depth paragraph about your project and overview of use

## Getting Started

### Prerequisites
- go version v1.22.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.

### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**

```sh
make docker-build docker-push IMG=<some-registry>/kidecar:tag
```

**NOTE:** This image ought to be published in the personal registry you specified.
And it is required to have access to pull the image from the working environment.
Make sure you have the proper permission to the registry if the above commands donโ€™t work.

**Install the CRDs into the cluster:**

```sh
make install
```

**Deploy the Manager to the cluster with the image specified by `IMG`:**

```sh
make deploy IMG=<some-registry>/kidecar:tag
```

> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.

**Create instances of your solution**
You can apply the samples (examples) from the config/sample:

```sh
kubectl apply -k config/samples/
```

>**NOTE**: Ensure that the samples has default values to test it out.
### To Uninstall
**Delete the instances (CRs) from the cluster:**

```sh
kubectl delete -k config/samples/
```

**Delete the APIs(CRDs) from the cluster:**

```sh
make uninstall
```

**UnDeploy the controller from the cluster:**

```sh
make undeploy
```

## Project Distribution

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

```sh
make build-installer IMG=<some-registry>/kidecar:tag
```

NOTE: The makefile target mentioned above generates an 'install.yaml'
file in the dist directory. This file contains all the resources built
with Kustomize, which are necessary to install this project without
its dependencies.

2. Using the installer

Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:

```sh
kubectl apply -f https://raw.githubusercontent.com/<org>/kidecar/<tag or branch>/dist/install.yaml
```

## Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project

**NOTE:** Run `make help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## License

Copyright 2024.

Licensed 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.

## hot-update
1. kubectl apply -f ./example/hot-update.yaml
2. ไธบpodๅˆ›ๅปบๅ…ฌ็ฝ‘่ฎฟ้—ฎ็š„service
3. ๆ‰ง่กŒๆ›ดๆ–ฐ `curl -k -X POST -d "url=https://guox-tos.tos-cn-beijing.volces.com/2048/v2/index.html" http://101.126.47.208:5000/hot-update`
36 changes: 36 additions & 0 deletions api/v1alpha1/groupversion_info.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2024.
Licensed 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.
*/

// Package v1alpha1 contains API Schema definitions for the serverless v1alpha1 API group
// +kubebuilder:object:generate=true
// +groupName=serverless.vke.volcengine.com
package v1alpha1

import (
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/scheme"
)

var (
// GroupVersion is group version used to register these objects
GroupVersion = schema.GroupVersion{Group: "serverless.vke.volcengine.com", Version: "v1alpha1"}

// SchemeBuilder is used to add go types to the GroupVersionKind scheme
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

// AddToScheme adds the types in this group-version to the given scheme.
AddToScheme = SchemeBuilder.AddToScheme
)
Loading

0 comments on commit 637c10f

Please sign in to comment.