docs/dev/dependencies.md

# Managing Dependencies

## Build Dependencies

The following dependencies must be installed on your system before you can build the installer.

### Fedora, CentOS, RHEL

```sh
sudo dnf install golang-bin gcc-c++ zip
```

If you need support for [libvirt destroy](libvirt/README.md#cleanup), you should also install `libvirt-devel`.

### Go

We follow a hard flattening approach; i.e. direct and inherited dependencies are installed in the base `vendor/`.

Dependencies are managed with [Go Modules](https://github.com/golang/go/wiki/Modules) but committed directly to the repository.

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

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

This [guide](https://github.com/golang/go/wiki/Modules#how-to-use-modules) is a great source to learn more about using `go mod`.

For the sake of your fellow reviewers, commit vendored code separately from any other changes.
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
doc: minor update to installation doc 1. Replace yum by dnf. 2. Add zip to installation dependencies as it's really needed and not installed by default. 3. Update requitred golang version in does base what is currently in go.mod. 2024-08-02 11:53:47 +02:00			`sudo dnf install golang-bin 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
			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.`