openshift/installer
1
0
Fork 0
mirror of https://github.com/openshift/installer.git synced 2026-02-05 15:47:14 +01:00
Code Issues Releases Activity
Files
bb7d56e9274dc8f9f01ac7b7499d8a71d1ce99e5
installer/docs/dev/dependencies.md

92 lines
4.6 KiB
Markdown
Raw Normal View History

docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
# Managing Dependencies
docs/libvirt-howto: Add dependency installation. Add a few things to the libvirt howto after my first pass running it: - Add dependency installation - Start libvirtd - Show how to create the default libvirt storage pool - Renumber sections after inserting new sections - Fix rhcos image name - Clarify that when running the --permanent commands for firewalld are in addition to running the same commands without the flag - change reference to ../libvirt.yaml to libvirt.yaml to match where the file will be based on past instructions
2018-09-24 14:18:29 -04:00
## Build Dependencies
The following dependencies must be installed on your system before you can build the installer.
docs: Just use `yum` on Fedora too This is what I do. `dnf` no longer complains if invoked as `yum`; there's no point to having two separate sets of instructions. Also use `systemctl enable --now` for further brevity.
2018-10-22 12:14:49 -04:00
### Fedora, CentOS, RHEL
docs/libvirt-howto: Add dependency installation. Add a few things to the libvirt howto after my first pass running it: - Add dependency installation - Start libvirtd - Show how to create the default libvirt storage pool - Renumber sections after inserting new sections - Fix rhcos image name - Clarify that when running the --permanent commands for firewalld are in addition to running the same commands without the flag - change reference to ../libvirt.yaml to libvirt.yaml to match where the file will be based on past instructions
2018-09-24 14:18:29 -04:00
```sh
no-jira: add dev docs for bumping CAPI provider version Bumping CAPI provider version is currently a manual step with little documentation to follow. This commit gathers all knowledge of such steps for other contributors.
2025-03-14 13:02:48 -07:00
sudo dnf install gcc-c++ zip
docs/libvirt-howto: Add dependency installation. Add a few things to the libvirt howto after my first pass running it: - Add dependency installation - Start libvirtd - Show how to create the default libvirt storage pool - Renumber sections after inserting new sections - Fix rhcos image name - Clarify that when running the --permanent commands for firewalld are in addition to running the same commands without the flag - change reference to ../libvirt.yaml to libvirt.yaml to match where the file will be based on past instructions
2018-09-24 14:18:29 -04:00
```
docs: Stronger per-platform isolation Punt per-platform docs down into platform-specific subdirectories so we can apply platform-specific OWNERS files.
2019-04-10 12:37:55 -07:00
If you need support for [libvirt destroy](libvirt/README.md#cleanup), you should also install `libvirt-devel`.
pkg/destroy/libvirt: Add behind a libvirt_destroy build tag Docs for Go's build constraints are in [1]. This commit allows folks with local libvirt C libraries to compile our libvirt deletion logic (and get a dynamically-linked executable), while release binaries and folks without libvirt C libraries can continue to get statically-linked executables that lack libvirt deletion. I've also simplified the public names (e.g. NewDestroyer -> New), dropping information which is already encoded in the import path. Pulling the init() registration out into separate files is at Abhinav's request [2]. [1]: https://golang.org/pkg/go/build/#hdr-Build_Constraints [2]: https://github.com/openshift/installer/pull/387#discussion_r221763315
2018-10-01 13:56:45 -07:00
docs/dev/dependencies: Nest "Go" under "Build Dependencies" This should have happened when "Build Dependencies" landed in 4278ba3f (docs/libvirt-howto: Add dependency installation, 2018-09-24, #315).
2018-11-14 15:53:38 -08:00
### Go
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
no-jira: add dev docs for bumping CAPI provider version Bumping CAPI provider version is currently a manual step with little documentation to follow. This commit gathers all knowledge of such steps for other contributors.
2025-03-14 13:02:48 -07:00
You can follow the official [Go Installation Doc](https://go.dev/doc/install) to install a compatible go version.
## Go Dependencies
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
We follow a hard flattening approach; i.e. direct and inherited dependencies are installed in the base `vendor/`.
docs: Update dependencies.md
2019-12-24 13:16:35 +01:00
Dependencies are managed with [Go Modules](https://github.com/golang/go/wiki/Modules) but committed directly to the repository.
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
docs: Update dependencies.md
2019-12-24 13:16:35 +01:00
- Add or update a dependency with `go get <dependency>@<version>`.
- If you want to use a fork of a project or ensure that a dependency is not updated even when another dependency requires a newer version of it, manually add a [replace directive in the go.mod file](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive).
- Run `go mod tidy` to tidy `go.mod` and update `go.sum`, then commit the changes.
- Run `go mod vendor` to re-vendor and then commit updated vendored code separately.
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
docs/dev/dependencies: Mention install-config YAML generation Catching up with c1dbb138f8 (pkg/types: ensure kubebuilder can build correct documentation, 2020-04-27, #3515), to make it easier for first-time or occasional contributors to figure out how to update that file.
2024-09-13 15:33:18 -07:00
If your vendor bump touched `github.com/openshift/api`, also run `go generate ./pkg/types/installconfig.go` to update [`data/data/install.openshift.io_installconfigs.yaml`](/data/data/install.openshift.io_installconfigs.yaml).
docs: Update dependencies.md
2019-12-24 13:16:35 +01:00
This [guide](https://github.com/golang/go/wiki/Modules#how-to-use-modules) is a great source to learn more about using `go mod`.
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
For the sake of your fellow reviewers, commit vendored code separately from any other changes.
no-jira: add dev docs for bumping CAPI provider version Bumping CAPI provider version is currently a manual step with little documentation to follow. This commit gathers all knowledge of such steps for other contributors.
2025-03-14 13:02:48 -07:00
### CAPI Provider Controller Dependencies
The installer uses Cluster API controllers to provision the cluster insfrastructure (more details [here](./cluster-api.md)). Each provider are vendored to `cluster-api/providers/<provider-name>` (e.g. `cluster-api/providers/aws` for AWS platform).
Whenever there are changes in the CAPI provider projects that need to be available to the installer, we need to bump the provider version in the installer project. The following describes the process to do so. We will use AWS provider (CAPA) as an example, but other providers should follow the same steps.
#### Bump provider `go.mod`
We need to set the version of CAPI provider to the revisions with the changes in the provider `go.mod`.
```bash
# At the project root (i.e. <path>/installer)
cd cluster-api/providers/aws/
# For example:
# - With commit ref: go get sigs.k8s.io/cluster-api-provider-aws/v2@17a09f591
# - With a released version, go get sigs.k8s.io/cluster-api-provider-aws/v2@v2.7.1
go get sigs.k8s.io/cluster-api-provider-aws/v2@<revision>
go mod tidy && go mod vendor
```
**Important**: If CAPI provider project has a `replace` block, we need to make sure provider `go.mod` matches that. For example, the [CAPA `go.mod`](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/5b4f7c1acb52392ec4121b4145468a4bbecf26fd/go.mod#L7-L13) and [provider `go.mod`](https://github.com/openshift/installer/blob/73b390363572305eed214627abca83b5b00d70d3/cluster-api/providers/aws/go.mod#L165-L171) must match if any.
#### Bump installer top-level `go.mod`
We need to also set the same version of CAPI provider in the installer top-level `go.mod`.
```bash
# At the project root (i.e. <path>/installer)
# For example:
# - With commit ref: go get sigs.k8s.io/cluster-api-provider-aws/v2@17a09f591
# - With a released version, go get sigs.k8s.io/cluster-api-provider-aws/v2@v2.7.1
go get sigs.k8s.io/cluster-api-provider-aws/v2@<revision>
go mod tidy && go mod vendor
```
#### Update infrastructure CRDs
When bumping version of the CAPI provider, some infrastructure CRDs might be updated and we need to ensure the installer is aware of that as it keeps a copy of the CRD in directory `data/data/cluster-api/`.
First, clone the upstream CAPI provider project.
```bash
# We need to have a copy of the CAPI provider project if not yet
git clone git@github.com:kubernetes-sigs/cluster-api-provider-aws.git
cd cluster-api-provider-aws
# Checkout the revision with changes
git fetch origin && git checkout <revision>
```
Next, generate the CRD manifest. The manifest will be available in `out/infrastructure-components.yaml`. We then copy it over to the installer project's corresponding infrastructure manifest.
```bash
make release-manifests
cp out/infrastructure-components.yaml <path-to>/installer/data/data/cluster-api/aws-infrastructure-components.yaml
```
**Important**: If using a released version of CAPI provider, the CRD is available for downloading from the [release page](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases).
Copy Permalink