Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some maintenance for content owned by honeybadger #2424

Merged
merged 15 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
83 changes: 0 additions & 83 deletions src/content/meta/shared-installation.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in src/content/overview/developer-portal/index.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
title: Developer portal
description: Our Backstage-based developer portal is your engineer's front end to the platform. We provide our self-service user interface as plugins for Backstage, so engineers using your platform find all the information they need in the right place.
weight: 30
Expand All @@ -9,6 +9,9 @@
last_review_date: 2024-07-01
owner:
- https://github.com/orgs/giantswarm/teams/team-honeybadger
user_questions:
- What is the developer portal?
- What is Backstage?
---

Our developer portal based on [Backstage](https://www.cncf.io/projects/backstage/) is your engineer's front end to the platform. We provide our self-service user interface as plugins for Backstage, so that engineers using your platform find all the information they need in the place they visit frequently.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in src/content/tutorials/continuous-deployment/apps/add-app-template.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
linkTitle: Add a new app template
title: Add a new app template
description: Learn how to create application templates to deploy apps using GitOps.
Expand Down Expand Up @@ -93,4 +93,4 @@
# You can add here the configmap in case of generate it via kubectl gs command or manually
```

At this point, you should have an app template ready. Now, you can [add a new app to a workload cluster using the template]({{< relref "/tutorials/continuous-deployment/apps/add_appcr" >}}).
At this point, you should have an app template ready. Now, you can [add a new app to a workload cluster using the template]({{< relref "/tutorials/continuous-deployment/apps/add-appcr" >}}).
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in src/content/tutorials/continuous-deployment/apps/add-appcr.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
linkTitle: Add a new App to a workload cluster
title: Add a new App to a workload cluster
description: Learn how to deploy and configure applications into workload clusters using GitOps.
Expand All @@ -18,7 +18,7 @@

# Add a new app to a workload cluster

You can add an `App` resource directly or based it on an [app template]({{< relref "/tutorials/continuous-deployment/apps/add_app_template/" >}}). The documentation below shows common steps as well as what's different in both cases.
You can add an `App` resource directly or based it on an [app template]({{< relref "/tutorials/continuous-deployment/apps/add-app-template/" >}}). The documentation below shows common steps as well as what's different in both cases.

## Examples

Expand Down Expand Up @@ -119,7 +119,7 @@

## Adding apps using a template

When using templates you need to pick a directory where templates live, as example `bases/apps`. Follow the [template creation tutorial]({{< relref "/tutorials/continuous-deployment/apps/add_app_template/" >}}) to learn how. Export the path to the directory in an environment variable:
When using templates you need to pick a directory where templates live, as example `bases/apps`. Follow the [template creation tutorial]({{< relref "/tutorials/continuous-deployment/apps/add-app-template/" >}}) to learn how. Export the path to the directory in an environment variable:

```sh
export APP_TEMPLATE_DIR=<your_base_directory>
Expand Down Expand Up @@ -167,4 +167,4 @@

__Note__: Alternatively, you can rely on [`Kustomize` patches](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patches/) to extend the `App` resource configuration instead.

At this point, everything is prepared and you can commit the changes to the branch to force `Flux` to apply the changes. Further you can learn how to [enable automatic updates for your apps]({{< relref "/tutorials/continuous-deployment/apps/automatic_updates_appcr/" >}}).
At this point, everything is prepared and you can commit the changes to the branch to force `Flux` to apply the changes. Further you can learn how to [enable automatic updates for your apps]({{< relref "/tutorials/continuous-deployment/apps/automatic-updates-appcr" >}}).
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in src/content/tutorials/continuous-deployment/apps/app-sets.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
linkTitle: Creating and using App Sets
title: Creating and using App Sets
description: Learn how to create and use App Sets for applications deployed with GitOps.
Expand Down Expand Up @@ -46,7 +46,7 @@

## Creating an app set template

Creating an `App Set` template isn't much different than [creating an app template]({{< relref "/tutorials/continuous-deployment/apps/add_app_template" >}}). Please make sure to read the documentation first.
Creating an `App Set` template isn't much different than [creating an app template]({{< relref "/tutorials/continuous-deployment/apps/add-app-template" >}}). Please make sure to read the documentation first.

To get started, go to the `bases` directory and create a subdirectory for your `App Set` template. In the directory, create a `kustomization.yaml` similar to the one below:

Expand Down Expand Up @@ -96,11 +96,11 @@
- One of the key benefits of `App Sets` is to be able to provide a specific set of app versions, that's known to make the apps work well together. To achieve that you see a set of in-line patches exposing the versions of the apps.
- When using `App` resources, you have three configuration slots available: `config`, `extraConfigs` and `userConfig`. Learn more about them in the [app configuration]({{< relref "/tutorials/fleet-management/app-platform/app-configuration" >}}) documentation.
- It's recommended to re-use app templates to create `App Set` templates. You can observe the apps defined in the `resources:` are `App` templates, that can be also used standalone.
- Secrets can be created the same way as explained in the [app templates]({{< relref "/tutorials/continuous-deployment/apps/add_app_template" >}}) and override the same as `ConfigMaps` or secrets when creating [App from a Template]({{< relref "/tutorials/continuous-deployment/apps/add_appcr/#adding-app-using-app-template" >}}).
- Secrets can be created the same way as explained in the [app templates]({{< relref "/tutorials/continuous-deployment/apps/add-app-template" >}}) and override the same as `ConfigMaps` or secrets when creating [App from a Template]({{< relref "/tutorials/continuous-deployment/apps/add-appcr/#adding-app-using-app-template" >}}).

## Use an app set

Using an `App Set` template is similar to use a single [`App Set`]({{< relref "/tutorials/continuous-deployment/apps/add_appcr#adding-app-using-app-template" >}}). To create one, save a path that contains your desired `App Set` template in the [gitops-template repository in "bases/app_sets"](https://github.com/giantswarm/gitops-template/tree/main/bases/app_sets/) directory. Then, create a new directory in the `app_sets` directory of your working cluster. In that directory, create a `kustomization.yaml` file based on the following pattern:
Using an `App Set` template is similar to use a single [`App Set`]({{< relref "/tutorials/continuous-deployment/apps/add-appcr#adding-app-using-app-template" >}}). To create one, save a path that contains your desired `App Set` template in the [gitops-template repository in "bases/app_sets"](https://github.com/giantswarm/gitops-template/tree/main/bases/app_sets/) directory. Then, create a new directory in the `app_sets` directory of your working cluster. In that directory, create a `kustomization.yaml` file based on the following pattern:

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
Expand All @@ -119,4 +119,4 @@
- ../../../../../../../../../bases/app_sets/hello-web-app
```

Above you can see how it's override the configuration of the `hello-world` app from the original template. The configuration replaces the `extraConfigs` property using the values from `override_config_hello_world` YAML file. This modifies the keys that match from original template definition. Notice the example overwrites the `namespace` as well for the whole app deployment. If you want to learn more about how configuration overrides work, please read our [docs about creating apps]({{< relref "/tutorials/continuous-deployment/apps/add_appcr" >}}).
Above you can see how it's override the configuration of the `hello-world` app from the original template. The configuration replaces the `extraConfigs` property using the values from `override_config_hello_world` YAML file. This modifies the keys that match from original template definition. Notice the example overwrites the `namespace` as well for the whole app deployment. If you want to learn more about how configuration overrides work, please read our [docs about creating apps]({{< relref "/tutorials/continuous-deployment/apps/add-appcr" >}}).
File renamed without changes.
File renamed without changes.
File renamed without changes.

This file was deleted.

File renamed without changes.
8 changes: 4 additions & 4 deletions src/content/tutorials/registry/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
linkTitle: Registry
title: Registry guides
linkTitle: Container registries
title: Container registries
description: How to reduce cost for container registries and improve performance and reliability.
weight: 15
weight: 70
aliases:
- /tutorials/registry
menu:
Expand All @@ -11,5 +11,5 @@ menu:
identifier: tutorials-registry
owner:
- https://github.com/orgs/giantswarm/teams/team-honeybadger
last_review_date: 2024-07-12
last_review_date: 2024-12-13
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in src/content/tutorials/registry/zot/index.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
linkTitle: Container image cache in the cluster
title: Setting up a caching container registry within a cluster using Zot
description: A registry cache within the cluster can provide benefits for availability, performance, and cost. Here we explain how to set up a registry, using the Zot app provided by Giant Swarm.
Expand All @@ -24,9 +24,9 @@
Here we explain how to set up a registry, using the [Zot](https://zotregistry.dev/) app provided by Giant Swarm. Zot is an OCI-native container image registry. The [Giant Swarm packaged version](https://github.com/giantswarm/zot) extends it with opinionated components like
autoscaling, monitoring, Cilium network policies, etc.

We explain how to deploy apps in our [app platform docs]({{< relref "/vintage/getting-started/app-platform/deploy-app/#creating-an-app-cr" >}}).
We explain how to deploy apps in our [app platform docs]({{< relref "/tutorials/fleet-management/app-platform/deploy-app/#creating-an-app-resource" >}}).

### Zot configuration
## Zot configuration

The Zot binary itself can be configured via `.configFiles.config.json` Helm value as JSON. The `.mountConfig` values must be set to `true` to enable mounting the configuration file.

Expand All @@ -40,7 +40,7 @@

The Zot project provides a [full configuration reference](https://zotregistry.dev/latest/admin-guide/admin-configuration/) with more details.

### Caching strategies
## Caching strategies

You can configure either active or on-demand replication via the Zot configuration file.

Expand Down Expand Up @@ -96,7 +96,7 @@

For the full mirroring documentation, check the [upstream documentation](https://zotregistry.dev/latest/articles/mirroring/).

### Restricting access to container images
## Restricting access to container images

If not configured specifically, access to the registry is public for anonymous users. This means that all workloads within the cluster can pull images from it.

Expand Down Expand Up @@ -168,7 +168,7 @@

Note how the `"policies"` key is used to define the access control for the repositories. The `"**"` key is a wildcard for all repositories. The `"actions"` key defines the allowed actions for the users.

#### Exposing the registry
### Exposing the registry

In some use-cases you possibly want to expose Zot to be used by let's say workload clusters, so you manage only a single instance by sharing it across multiple workloads.

Expand Down Expand Up @@ -224,11 +224,11 @@
}
```

### Configuration recommendations
## Configuration recommendations

Depending on your use of Zot, please consider these additional recommendations for your deployment.

#### Memory constraints
### Memory constraints

Zot can take up a lot of memory over time. In the Giant Swarm packaged app you can deploy it with a vertical pod autoscaler (VPA). You can set the resource constraints like shown here:

Expand Down Expand Up @@ -285,9 +285,9 @@
value: 800MiB
```

For more details on this approach, we recommend to read the [Guide to the Go Garbage Collector](https://tip.golang.org/doc/gc-guide).
For more details on this approach, we recommend to read the [guide to the Go garbage collector](https://tip.golang.org/doc/gc-guide).

#### Deployment strategies
### Deployment strategies

Some extension, like `search` can create file locks on the data volume mount. With the `RollingUpdate` strategy,
this will cause the new pods failing to stand up. In such scenarios it's recommended to set it to `Recreate`.
Expand Down
2 changes: 1 addition & 1 deletion src/content/vintage/advanced/gitops/apps/app_sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Please note the following in the example above:
- One of the key benefits of App Sets is to be able to provide a specific set of app versions, that is known to make the apps work well together. Over here, we do that as a set of in-line patches, so it is immediately visible in the `kustomization.yaml` file which versions are used.
- When using `App` CRs, we have two configuration slots available: `config` and `userConfig`. Since we always want to leave `userConfig` at the end users disposal, we're left with overriding the whole ConfigMap coming from the base application as the only option.
- It is recommended to re-use App Templates to create App Set Templates. That's exactly what we do here: apps defined in the `resources:` block are App Templates, that, if needed, can be also used standalone.
- The example above doesn't cover handling Secrets - we do that for brevity. Secrets can be created the same way as in normal [app templates]({{< relref "/tutorials/continuous-deployment/apps/add_app_template" >}}) and overrode the same as `ConfigMaps` or `Secrets` when creating [app from a template](/advanced/gitops/apps/add_appcr/#adding-app-using-app-template).
- The example above doesn't cover handling Secrets - we do that for brevity. Secrets can be created the same way as in normal [app templates]({{< relref "/tutorials/continuous-deployment/apps/add-app-template" >}}) and overrode the same as `ConfigMaps` or `Secrets` when creating [app from a template](/advanced/gitops/apps/add_appcr/#adding-app-using-app-template).

## Using an App Set

Expand Down
Loading