-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add helm plugin to distribute the projects
- Loading branch information
1 parent
eae8b21
commit 44c23e2
Showing
97 changed files
with
4,294 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| name: Helm Testdata Sample | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - 'testdata/project-v4-with-plugins/**' | ||
| - 'testdata/project-v4-multigroup/**' | ||
| - '.github/workflows/test-helm-samples.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'testdata/project-v4-with-plugins/**' | ||
| - 'testdata/project-v4-multigroup/**' | ||
| - '.github/workflows/test-helm-samples.yml' | ||
|
|
||
| jobs: | ||
| helm-test-project-v4-with-plugins: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: true | ||
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version: '~1.22' | ||
|
|
||
| - name: Install the latest version of kind | ||
| run: | | ||
| curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64 | ||
| chmod +x ./kind | ||
| sudo mv ./kind /usr/local/bin/kind | ||
| - name: Verify kind installation | ||
| run: kind version | ||
|
|
||
| - name: Create kind cluster | ||
| run: kind create cluster | ||
|
|
||
| - name: Prepare project-v4-with-plugins | ||
| run: | | ||
| cd testdata/project-v4-with-plugins/ | ||
| go mod tidy | ||
| make docker-build IMG=project-v4-with-plugins:v0.1.0 | ||
| kind load docker-image project-v4-with-plugins:v0.1.0 | ||
| - name: Install Helm | ||
| run: | | ||
| curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash | ||
| - name: Verify Helm installation | ||
| run: helm version | ||
|
|
||
| - name: Lint Helm chart for project-v4-with-plugins | ||
| run: | | ||
| helm lint testdata/project-v4-with-plugins/dist/chart | ||
| - name: Install Helm chart for project-v4-with-plugins | ||
| run: | | ||
| helm install my-release testdata/project-v4-with-plugins/dist/chart --create-namespace --namespace project-v4-with-plugins-system | ||
| helm-test-project-v4-multigroup: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: true | ||
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version: '~1.22' | ||
|
|
||
| - name: Install the latest version of kind | ||
| run: | | ||
| curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64 | ||
| chmod +x ./kind | ||
| sudo mv ./kind /usr/local/bin/kind | ||
| - name: Verify kind installation | ||
| run: kind version | ||
|
|
||
| - name: Create kind cluster | ||
| run: kind create cluster | ||
|
|
||
| - name: Prepare project-v4-multigroup | ||
| run: | | ||
| cd testdata/project-v4-multigroup/ | ||
| go mod tidy | ||
| make docker-build IMG=project-v4-multigroup:v0.1.0 | ||
| kind load docker-image project-v4-multigroup:v0.1.0 | ||
| - name: Install Helm | ||
| run: | | ||
| curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash | ||
| - name: Verify Helm installation | ||
| run: helm version | ||
|
|
||
| - name: Lint Helm chart for project-v4-multigroup | ||
| run: | | ||
| helm lint testdata/project-v4-multigroup/dist/chart | ||
| - name: Install Helm chart for project-v4-multigroup | ||
| run: | | ||
| helm install my-release-multigroup testdata/project-v4-multigroup/dist/chart --create-namespace --namespace project-v4-multigroup-system |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Helm Plugin (`helm/v1-alpha`) | ||
|
|
||
| The Helm plugin is an optional plugin that can be used to scaffold a Helm chart, allowing you to distribute the project using Helm. | ||
|
|
||
| By default, users can generate a bundle with all the manifests by running the following command: | ||
|
|
||
| ```bash | ||
| make build-installer IMG=<some-registry>/<project-name:tag> | ||
| ``` | ||
|
|
||
| This allows the project consumer to install the solution by applying the bundle with: | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4/<tag or branch>/dist/install.yaml | ||
| ``` | ||
|
|
||
| However, in many scenarios, you might prefer to provide a Helm chart to package your solution. | ||
| If so, you can use this plugin to generate the Helm chart under the `dist` directory. | ||
|
|
||
| <aside class="note"> | ||
| <h1>Examples</h1> | ||
|
|
||
| You can check its default scaffold by looking at the `project-v4-with-plugins` projects | ||
| under the [testdata][testdata] directory on the root directory of the Kubebuilder project. | ||
|
|
||
| </aside> | ||
|
|
||
| ## When to use it ? | ||
|
|
||
| - If you are looking to provide to your users a HelmChart to install and manage your project | ||
|
|
||
| ## How to use it ? | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| The Helm plugin is attached to the `init` subcommand and the `edit` subcommand: | ||
|
|
||
| ```sh | ||
| # Initialize a new project with helm chart | ||
| kubebuilder init --plugins helm/v1-alpha | ||
|
|
||
| # Enable or Update the helm chart via the helm plugin to an existing project | ||
| kubebuilder edit --plugins helm/v1-alpha | ||
| ``` | ||
|
|
||
| ## Subcommands | ||
|
|
||
| The Helm plugin implements the following subcommands: | ||
|
|
||
| - edit (`$ kubebuilder edit [OPTIONS]`) | ||
|
|
||
| - init (`$ kubebuilder init [OPTIONS]`) | ||
|
|
||
| ## Affected files | ||
|
|
||
| The following scaffolds will be created or updated by this plugin: | ||
|
|
||
| - `dist/chart/*` | ||
|
|
||
| [testdata]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/testdata/project-v4-with-plugins | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 v1alpha | ||
|
|
||
| import ( | ||
| "errors" | ||
|
|
||
| "sigs.k8s.io/kubebuilder/v4/pkg/config" | ||
| ) | ||
|
|
||
| func insertPluginMetaToConfig(target config.Config, cfg pluginConfig) error { | ||
| err := target.DecodePluginConfig(pluginKey, cfg) | ||
| if !errors.As(err, &config.UnsupportedFieldError{}) { | ||
| if err != nil && !errors.As(err, &config.PluginKeyNotFoundError{}) { | ||
| return err | ||
| } | ||
| if err = target.EncodePluginConfig(pluginKey, cfg); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 v1alpha | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/spf13/pflag" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/config" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/machinery" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/plugin" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds" | ||
| ) | ||
|
|
||
| var _ plugin.EditSubcommand = &editSubcommand{} | ||
|
|
||
| type editSubcommand struct { | ||
| config config.Config | ||
| force bool | ||
| } | ||
|
|
||
| func (p *editSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) { | ||
| subcmdMeta.Description = `Initialize a helm chart to distribute the project under dist/ | ||
| ` | ||
| subcmdMeta.Examples = fmt.Sprintf(` # Initialize a helm chart to distribute the project under dist/ | ||
| %[1]s edit --plugins helm/v1alpha | ||
| `, cliMeta.CommandName) | ||
| } | ||
|
|
||
| func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) { | ||
| fs.BoolVar(&p.force, "force", true, "if true, run re-generate the files") | ||
| } | ||
|
|
||
| func (p *editSubcommand) InjectConfig(c config.Config) error { | ||
| p.config = c | ||
| return nil | ||
| } | ||
|
|
||
| func (p *editSubcommand) Scaffold(fs machinery.Filesystem) error { | ||
| scaffolder := scaffolds.NewInitHelmScaffolder(p.config, p.force) | ||
| scaffolder.InjectFS(fs) | ||
| err := scaffolder.Scaffold() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Track the resources following a declarative approach | ||
| if err := insertPluginMetaToConfig(p.config, pluginConfig{}); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.