## 1. Project Overview & Quickstart (fluxcd/values.yaml) # values.yaml Open-source repository fluxcd/values.yaml ### Repository Details - **Repository:** [fluxcd/values.yaml](https://github.com/fluxcd/values.yaml) - **Primary Language:** Code *Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.* ## 2. Official Technical Reference & Guides (fluxcd/website) # fluxcd.io [](https://app.netlify.com/sites/fluxcd/deploys) This repo houses the assets used to build the Flux project's landing page at . > **Note**: The sources for some of Flux's documentation are housed in other repositories within . Documentation issues and pull requests should be made against those repos. > > Project | Docs Site | GitHub Source > ---------------- | ------------------------------------------| ------------- > Flux | | > Flagger | | ## How to modify this website The main landing page of this website can be modified in `hugo.yaml`. Almost all of the content lives in the `content/en/` directories. Here are some special cases. - `./content/en/blog` contains all blog posts - make sure you update the front-matter for posts to show up correctly. - `./external-sources/` defines how files from other repositories are pulled in. We currently do this for Markdown files from the `/fluxcd/community` and `/fluxcd/.github` repositories. (`make gen-content` pulls these in.) - Flux CLI docs (`cmd`) and `components` docs: under `./content/en/flux` but pulled in through in `make gen-content` as well. - `/static/_redirects` defines redirects on . Check out for the syntax definition and how to test if things work. ## Running the site locally In order to run the Flux site locally, you need to install: - [Node.js](https://www.npmjs.com/get-npm) - The [Hugo](https://gohugo.io) static site generator. Make sure to [install](https://gohugo.io/getting-started/installing/) the "extended" variant of Hugo with support for the [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) feature and to check the [`netlify.toml`](https://github.com/fluxcd/website/blob/main/netlify.toml) configuration file for which version of Hugo you should install. - [jq](https://stedolan.github.io/jq/download/) Once those tools are installed, fetch the assets necessary to run the site: Then run the site in "server" mode: ```cli make serve ``` Navigate to to see the site running in your browser. As you make updates to the site, the browser will immediately update to reflect those changes. > **Note**: Sometimes you need to clear the output of previous builds, e.g. when the structure of imported documentation has changed. If you see duplicate pages being served, run > ``` > git clean -fx -- content/ > ``` > and then run `make serve` again. The duplicates will then be gone. ## Publishing the site The Flux website is published automatically by [Netlify](https://netlify.com) when changes are pushed to the `main` branch. The site does not need to be published manually. ### Preview builds When you submit a pull request to this repository, Netlify builds a "deploy preview" of your changes. You can see that preview by clicking on the **Details** link of the **netlify/fluxcd/deploy-preview** check at the bottom of the pull request page. ## Local Development (docker) Run `make docker-preview` and wait until the following output appears: ```cli Environment: "development" Serving pages from memory Web Server is available at //localhost:1313/ (bind address 0.0.0.0) Press Ctrl+C to stop ``` Visit [http://localhost:1313](http://localhost:1313), where any changes will be visible from inside of the running container. Markdown files updated in `content/` should trigger a browser refresh as they are saved. The `docker-preview` target builds the theme, which takes a while and doesn't need to be repeated unless you are making changes to the theme. On subsequent runs, running `make docker-serve` instead will skip building the theme. This depends on the Docker image `fluxcd/website:hugo-support` which should be kept updated when the website's build-time dependencies have changed; this image contains everything needed to run the docs locally. If this doesn't work, the image may be stale. The instructions to update it are below. ### Remote Development (kubernetes / okteto CLI) This works the same as local development above, but with the Okteto CLI you do not need to run a Linux machine or virtual machine on your local development environment. First, make sure you are permitted to deploy pods on any local or remote Kubernetes cluster. Download the [Okteto CLI](https://okteto.com/docs/getting-started/installation/index.html) for Windows, Mac, or Linux. Okteto CLI is a light-weight client-side tool that replaces Docker with a remote cluster. You can run `hugo server` remotely in this way; any changes to the local clone are synchronized to the cluster. The experience is basically the same as local development, (except that you won't need to install Docker.) Instead of `make docker-serve`, type `okteto up`. You can change the behavior in `okteto.yml` according to the [Okteto Manifest Reference](https://okteto.com/docs/reference/manifest/index.html), for example adding a persistent volume can speed up the synchronization of the working directory files to the remote pod on repeated runs. ### Updating the Development/preview container image (For maintainers) Using a machine with `docker` and logged in with an account that has permission to push to `docker.io/fluxcd/website` repo, run `make docker-push`. The dependencies of `docker-push` are explained below. If the above worked then you are done, and should not need to read any further. Rebuilding `hugo` takes a long time and should be avoided when the version hasn't changed or it isn't needed; run `make docker-push-support` instead to skip building `hugo`. Update the `docker-support` image tag whenever build-time (or "serve"-time) dependencies have changed. #### How is the Development container made? These targets as explained below are run in the appropriate order as dependencies of `make docker-push`. - [ ] `TODO`: add a system/integration test for `website` that verifies any changes have not broken `make docker-serve`, for example by adding new dependencies without mentioning them in the `./Dockerfile`. ##### Flux-specific Dependencies The Flux website has some build-time dependencies including Python3, PyYAML, `rsync`, `grep`, `nodejs`, `npm`, `curl`, `jq`, (and potentially others that may be added in the future.) Flux-specific dependencies are prepared in an image that gets tagged as `docker.io/fluxcd/website:hugo-support`. This image is built from the `Dockerfile` in `./`; run `make docker-build-support` to rebuild it locally, (or run as `make docker-push-support` to build and also push.) ##### `gohugoio/hugo` The Flux website also depends on a specific version of Hugo, which unfortunately does not provide docker images for each version. So we build it from source, with the `HUGO_BUILD_TAGS=extended` build arg enabled. Run `make docker-push-hugo` to build and also push this image target. This will run `make hugo` to get a shallow clone of the `gohugoio/hugo` repository at the right `HUGO_VERSION` and `make docker-build-hugo` to build a hugo container base image. (This target compiles `golibsass` which is very large, and may take a while.) These are all the dependencies of `make docker-push`.