Skip to content

chore: fix up reference to fluxcd docs for secret #267

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 30, 2025
Merged

chore: fix up reference to fluxcd docs for secret #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebf5937
chore: fix up reference to fluxcd docs for secret
abangser May 14, 2025
0d9ea83
chore: PR suggestions
abangser May 29, 2025
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
21 changes: 17 additions & 4 deletions docs/main/04-guides/02-installing-gitops-agent/01-flux.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ resource depending on the type of state store you are using.
configuration and authentication options for the `Bucket` resource, see the
[FluxCD docs](https://fluxcd.io/flux/components/source/buckets/).

:::info
This example depends on a secret called `minio-credentials` existing in the
`flux-system` namespace. This is only necessary if the repository is private
and there are a number of authentication options described in the
[FluxCD docs](https://fluxcd.io/flux/components/source/gitrepositories/#secret-reference).
:::

```yaml
---
apiVersion: source.toolkit.fluxcd.io/v1beta1
Expand Down Expand Up @@ -90,6 +97,13 @@ resource depending on the type of state store you are using.
authentication opitions for the `GitRepository` resource, see the [FluxCD
docs](https://fluxcd.io/flux/components/source/gitrepositories/).

:::info
This example depends on a secret called `git-credentials` existing in the
`flux-system` namespace. This is only necessary if the repository is private
and there are a number of authentication options described in the
[FluxCD docs](https://fluxcd.io/flux/components/source/gitrepositories/#secret-reference).
:::

```yaml
---
apiVersion: source.toolkit.fluxcd.io/v1
Expand All @@ -108,11 +122,10 @@ resource depending on the type of state store you are using.
apiVersion: v1
kind: Secret
metadata:
name: ssh-credentials
name: git-credentials
namespace: flux-system
spec:
type: Opaque
stringData:
type: Opaque
stringData:
identity: |
-----BEGIN OPENSSH PRIVATE KEY-----
...
Expand Down
10 changes: 8 additions & 2 deletions docs/ske/10-integrations/20-port.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,13 @@ repository that Port is writing to. An example set up when using FluxCD and the
from above can be found below.

<details>
<summary>Example Flux Resources for Port-Syncer repository</summary>
<summary>Example Flux Resources for `port-syncer` repository</summary>

:::info
This example resource depends on a secret called `git-credentials` to exist in the
`flux-system` namespace. This secret should be configured based on the
[FluxCD docs](https://fluxcd.io/flux/components/source/gitrepositories/#secret-reference).
:::

```
---
Expand All @@ -271,7 +277,7 @@ spec:
ref:
branch: main
secretRef:
name: github-creds
name: git-credentials
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
Expand Down