Skip to content

Commit 3829890

Browse files
wejdrosswejdross
authored
Merge pull request #140 from vshn/add/forgejo
adding base Forgejo docs
2 parents ebe209e + 8bf4673 commit 3829890

File tree

4 files changed

+186
-83
lines changed

4 files changed

+186
-83
lines changed

‎docs/modules/ROOT/nav.adoc

+84-82
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,19 @@
11
.The Application Catalog
22
* xref:getting-started.adoc[]
3+
* xref:references/cloud-zones.adoc[Cloud Zones]
34
* xref:references/crds.adoc[CRD Reference]
45
* xref:references/secrets.adoc[Connection Secrets]
5-
* xref:references/cloud-zones.adoc[Cloud Zones]
6-
* xref:vshn-managed/how-tos/logging.adoc[Service Logs]
76
* xref:vshn-managed/how-tos/access_metrics.adoc[Metrics]
7+
* xref:vshn-managed/how-tos/logging.adoc[Service Logs]
88
9-
.PostgreSQL
10-
* xref:exoscale-dbaas/postgresql/index.adoc[On Exoscale]
11-
** xref:exoscale-dbaas/postgresql/create.adoc[Creation]
12-
** xref:exoscale-dbaas/postgresql/usage.adoc[Usage]
13-
** xref:exoscale-dbaas/postgresql/delete.adoc[Deletion]
14-
* xref:vshn-managed/postgresql/index.adoc[On cloudscale.ch]
15-
** xref:vshn-managed/postgresql/create.adoc[Creation]
16-
** xref:vshn-managed/postgresql/usage.adoc[Usage]
17-
** xref:vshn-managed/postgresql/connect.adoc[Connect]
18-
** xref:vshn-managed/postgresql/delete.adoc[Deletion]
19-
** xref:vshn-managed/postgresql/deletion-protection.adoc[]
20-
** xref:vshn-managed/postgresql/backup.adoc[Backup]
21-
** xref:vshn-managed/postgresql/restore.adoc[Restore]
22-
** xref:vshn-managed/postgresql/security.adoc[Security]
23-
** xref:vshn-managed/postgresql/maintenance.adoc[]
24-
** xref:vshn-managed/postgresql/plans.adoc[]
25-
** xref:vshn-managed/postgresql/sla.adoc[]
26-
** xref:vshn-managed/postgresql/encrypted-pvc.adoc[]
27-
** xref:vshn-managed/postgresql/alerting.adoc[]
28-
** xref:vshn-managed/postgresql/update-strategy.adoc[]
29-
** xref:vshn-managed/postgresql/extensions.adoc[]
30-
** xref:vshn-managed/postgresql/replicas.adoc[]
31-
** xref:vshn-managed/postgresql/usermanagement.adoc[]
32-
33-
.MySQL
34-
* xref:exoscale-dbaas/mysql/index.adoc[On Exoscale]
35-
** xref:exoscale-dbaas/mysql/create.adoc[Creation]
36-
** xref:exoscale-dbaas/mysql/usage.adoc[Usage]
37-
** xref:exoscale-dbaas/mysql/delete.adoc[Deletion]
38-
39-
.MariaDB
40-
* xref:vshn-managed/mariadb/index.adoc[On cloudscale.ch]
41-
** xref:vshn-managed/mariadb/create.adoc[Creation]
42-
** xref:vshn-managed/mariadb/maintenance.adoc[]
43-
** xref:vshn-managed/mariadb/usage.adoc[Usage]
44-
** xref:vshn-managed/mariadb/delete.adoc[Deletion]
45-
** xref:vshn-managed/mariadb/deletion-protection.adoc[]
46-
** xref:vshn-managed/mariadb/plans.adoc[]
47-
** xref:vshn-managed/mariadb/restore.adoc[Restore]
48-
** xref:vshn-managed/mariadb/security.adoc[Security]
49-
** xref:vshn-managed/mariadb/usermanagement.adoc[]
50-
** xref:vshn-managed/mariadb/replicas.adoc[]
51-
52-
.Redis
53-
* xref:exoscale-dbaas/redis/index.adoc[On Exoscale]
54-
** xref:exoscale-dbaas/redis/create.adoc[Creation]
55-
** xref:exoscale-dbaas/redis/usage.adoc[Usage]
56-
** xref:exoscale-dbaas/redis/delete.adoc[Deletion]
57-
* xref:vshn-managed/redis/index.adoc[On cloudscale.ch]
58-
** xref:vshn-managed/redis/create.adoc[Creation]
59-
** xref:vshn-managed/redis/maintenance.adoc[]
60-
** xref:vshn-managed/redis/usage.adoc[Usage]
61-
** xref:vshn-managed/redis/delete.adoc[Deletion]
62-
** xref:vshn-managed/redis/deletion-protection.adoc[]
63-
** xref:vshn-managed/redis/plans.adoc[]
64-
** xref:vshn-managed/redis/backup.adoc[Backup]
65-
** xref:vshn-managed/redis/restore.adoc[Restore]
66-
** xref:vshn-managed/redis/security.adoc[Security]
9+
.Advanced
10+
* xref:references/argocd.adoc[Usage with ArgoCD]
11+
* xref:references/permissions.adoc[Namespace Permissions]
12+
* xref:references/quotas.adoc[]
6713
14+
.Forgejo
15+
* xref:vshn-managed/forgejo/index.adoc[On cloudscale.ch]
16+
** xref:vshn-managed/forgejo/create.adoc[Creation]
6817
6918
.Kafka
7019
* xref:exoscale-dbaas/kafka/index.adoc[On Exoscale]
@@ -75,45 +24,98 @@
7524
.Keycloak
7625
* xref:vshn-managed/keycloak/index.adoc[On cloudscale.ch]
7726
** xref:vshn-managed/keycloak/create.adoc[Creation]
78-
** xref:vshn-managed/keycloak/maintenance.adoc[]
79-
** xref:vshn-managed/keycloak/usage.adoc[Usage]
27+
** xref:vshn-managed/keycloak/customization.adoc[]
8028
** xref:vshn-managed/keycloak/delete.adoc[Deletion]
8129
** xref:vshn-managed/keycloak/deletion-protection.adoc[]
30+
** xref:vshn-managed/keycloak/maintenance.adoc[]
8231
** xref:vshn-managed/keycloak/plans.adoc[]
32+
** xref:vshn-managed/keycloak/replicas.adoc[]
8333
** xref:vshn-managed/keycloak/restore.adoc[Restore]
8434
** xref:vshn-managed/keycloak/security.adoc[Security]
85-
** xref:vshn-managed/keycloak/replicas.adoc[]
86-
** xref:vshn-managed/keycloak/customization.adoc[]
35+
** xref:vshn-managed/keycloak/usage.adoc[Usage]
8736
37+
.MariaDB
38+
* xref:vshn-managed/mariadb/index.adoc[On cloudscale.ch]
39+
** xref:vshn-managed/mariadb/create.adoc[Creation]
40+
** xref:vshn-managed/mariadb/delete.adoc[Deletion]
41+
** xref:vshn-managed/mariadb/deletion-protection.adoc[]
42+
** xref:vshn-managed/mariadb/maintenance.adoc[]
43+
** xref:vshn-managed/mariadb/plans.adoc[]
44+
** xref:vshn-managed/mariadb/replicas.adoc[]
45+
** xref:vshn-managed/mariadb/restore.adoc[Restore]
46+
** xref:vshn-managed/mariadb/security.adoc[Security]
47+
** xref:vshn-managed/mariadb/usage.adoc[Usage]
48+
** xref:vshn-managed/mariadb/usermanagement.adoc[]
49+
50+
.MinIO
51+
* xref:vshn-managed/minio.adoc[On Private Cloud]
52+
53+
.MySQL
54+
* xref:exoscale-dbaas/mysql/index.adoc[On Exoscale]
55+
** xref:exoscale-dbaas/mysql/create.adoc[Creation]
56+
** xref:exoscale-dbaas/mysql/delete.adoc[Deletion]
57+
** xref:exoscale-dbaas/mysql/usage.adoc[Usage]
8858
8959
.Nextcloud
9060
* xref:vshn-managed/nextcloud/index.adoc[On cloudscale.ch]
61+
** xref:vshn-managed/nextcloud/backup.adoc[Backup]
62+
** xref:vshn-managed/nextcloud/collabora.adoc[Collabora]
9163
** xref:vshn-managed/nextcloud/create.adoc[Creation]
92-
** xref:vshn-managed/nextcloud/maintenance.adoc[]
93-
** xref:vshn-managed/nextcloud/usage.adoc[Usage]
9464
** xref:vshn-managed/nextcloud/delete.adoc[Deletion]
9565
** xref:vshn-managed/nextcloud/deletion-protection.adoc[]
66+
** xref:vshn-managed/nextcloud/maintenance.adoc[]
9667
** xref:vshn-managed/nextcloud/plans.adoc[]
97-
** xref:vshn-managed/nextcloud/collabora.adoc[Collabora]
98-
** xref:vshn-managed/nextcloud/backup.adoc[Backup]
99-
100-
.OpenSearch
101-
* xref:exoscale-dbaas/opensearch/index.adoc[On Exoscale]
102-
** xref:exoscale-dbaas/opensearch/create.adoc[Creation]
103-
** xref:exoscale-dbaas/opensearch/usage.adoc[Usage]
104-
** xref:exoscale-dbaas/opensearch/delete.adoc[Deletion]
68+
** xref:vshn-managed/nextcloud/usage.adoc[Usage]
10569
10670
.Object Storage (S3)
10771
* xref:object-storage/create.adoc[Creation]
108-
* xref:object-storage/usage.adoc[Usage]
109-
* xref:object-storage/secrets.adoc[Connection Secrets]
11072
* xref:object-storage/delete.adoc[Deletion]
11173
* xref:object-storage/references.adoc[Reference Documentation]
74+
* xref:object-storage/secrets.adoc[Connection Secrets]
75+
* xref:object-storage/usage.adoc[Usage]
11276
113-
.MinIO
114-
* xref:vshn-managed/minio.adoc[On Private Cloud]
77+
.OpenSearch
78+
* xref:exoscale-dbaas/opensearch/index.adoc[On Exoscale]
79+
** xref:exoscale-dbaas/opensearch/create.adoc[Creation]
80+
** xref:exoscale-dbaas/opensearch/delete.adoc[Deletion]
81+
** xref:exoscale-dbaas/opensearch/usage.adoc[Usage]
11582
116-
.Advanced
117-
* xref:references/permissions.adoc[Namespace Permissions]
118-
* xref:references/argocd.adoc[Usage with ArgoCD]
119-
* xref:references/quotas.adoc[]
83+
.PostgreSQL
84+
* xref:exoscale-dbaas/postgresql/index.adoc[On Exoscale]
85+
** xref:exoscale-dbaas/postgresql/create.adoc[Creation]
86+
** xref:exoscale-dbaas/postgresql/delete.adoc[Deletion]
87+
** xref:exoscale-dbaas/postgresql/usage.adoc[Usage]
88+
* xref:vshn-managed/postgresql/index.adoc[On cloudscale.ch]
89+
** xref:vshn-managed/postgresql/alerting.adoc[]
90+
** xref:vshn-managed/postgresql/backup.adoc[Backup]
91+
** xref:vshn-managed/postgresql/connect.adoc[Connect]
92+
** xref:vshn-managed/postgresql/create.adoc[Creation]
93+
** xref:vshn-managed/postgresql/delete.adoc[Deletion]
94+
** xref:vshn-managed/postgresql/deletion-protection.adoc[]
95+
** xref:vshn-managed/postgresql/encrypted-pvc.adoc[]
96+
** xref:vshn-managed/postgresql/extensions.adoc[]
97+
** xref:vshn-managed/postgresql/maintenance.adoc[]
98+
** xref:vshn-managed/postgresql/plans.adoc[]
99+
** xref:vshn-managed/postgresql/replicas.adoc[]
100+
** xref:vshn-managed/postgresql/restore.adoc[Restore]
101+
** xref:vshn-managed/postgresql/security.adoc[Security]
102+
** xref:vshn-managed/postgresql/sla.adoc[]
103+
** xref:vshn-managed/postgresql/update-strategy.adoc[]
104+
** xref:vshn-managed/postgresql/usage.adoc[Usage]
105+
** xref:vshn-managed/postgresql/usermanagement.adoc[]
106+
107+
.Redis
108+
* xref:exoscale-dbaas/redis/index.adoc[On Exoscale]
109+
** xref:exoscale-dbaas/redis/create.adoc[Creation]
110+
** xref:exoscale-dbaas/redis/delete.adoc[Deletion]
111+
** xref:exoscale-dbaas/redis/usage.adoc[Usage]
112+
* xref:vshn-managed/redis/index.adoc[On cloudscale.ch]
113+
** xref:vshn-managed/redis/backup.adoc[Backup]
114+
** xref:vshn-managed/redis/create.adoc[Creation]
115+
** xref:vshn-managed/redis/delete.adoc[Deletion]
116+
** xref:vshn-managed/redis/deletion-protection.adoc[]
117+
** xref:vshn-managed/redis/maintenance.adoc[]
118+
** xref:vshn-managed/redis/plans.adoc[]
119+
** xref:vshn-managed/redis/restore.adoc[Restore]
120+
** xref:vshn-managed/redis/security.adoc[Security]
121+
** xref:vshn-managed/redis/usage.adoc[Usage]

‎docs/modules/ROOT/pages/references/secrets.adoc

+19-1
Original file line numberDiff line numberDiff line change
@@ -255,4 +255,22 @@ stringData:
255255

256256

257257
NOTE: Not all fields apply to all providers
258-
// end::nextcloud[]
258+
// end::nextcloud[]
259+
260+
// tag::forgejo[]
261+
[source,yaml]
262+
----
263+
apiVersion: v1
264+
kind: Secret
265+
stringData:
266+
FORGEJO_PASSWORD: a09gGvIF3cKDlD7K <1>
267+
FORGEJO_URL: forgejo.mydomain.com <2>
268+
FORGEJO_USERNAME: forgejo_admin <3>
269+
metadata:
270+
(...) # omitted for brevity
271+
272+
----
273+
274+
<1> Password for the Forgejo instance
275+
<2> URL to access the Forgejo instance
276+
<3> Username to access the Forgejo instance

‎docs/modules/ROOT/pages/vshn-managed/forgejo/create.adoc

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
= Create a Forgejo service
2+
3+
[WARNING]
4+
====
5+
VSHNForgejo is currently in alpha. This means that the service is still under active development and may undergo significant changes. Users should be aware that there may be bugs, incomplete features, and potential instability. We appreciate your feedback and encourage you to report any issues you encounter.
6+
====
7+
8+
Apply the following object on your namespace, as specified by its YAML description.
9+
10+
.Example to create a Forgejo instance
11+
[source,yaml]
12+
----
13+
apiVersion: vshn.appcat.vshn.io/v1
14+
kind: VSHNForgejo
15+
metadata:
16+
name: forgejo-app1-prod <1>
17+
namespace: mynamespace <2>
18+
spec:
19+
parameters:
20+
service:
21+
adminEmail: "[email protected]" <3>
22+
fqdn:
23+
- "forgejo.mydomain.com" <3>
24+
version: "10.0.0" <4>
25+
writeConnectionSecretToRef:
26+
name: forgejo-creds <5>
27+
----
28+
<1> Instance name
29+
<2> The namespace where the object will be created
30+
<3> Your full qualified domain name
31+
<4> Forgejo version - link:https://products.vshn.ch/appcat/forgejo.html#_supported_versions[Supported Versions]
32+
<5> The name of the secret where the connection details will be stored, it must be unique per namespace
33+
34+
NOTE: To get more information about all available configuration options, please see the xref:references/crds.adoc#k8s-api-github-com-vshn-component-appcat-apis-vshn-v1-vshnForgejo[API Reference]
35+
36+
== Inspect your new Forgejo service
37+
38+
[source,bash]
39+
----
40+
$ oc get vshnforgejo.vshn.appcat.vshn.io
41+
NAME SYNCED READY CONNECTION-SECRET AGE
42+
forgejo-app1-prod True True forgejo-creds 4m23s
43+
----
44+
45+
When you see `True` in the READY column, it means the instance is provisioned but the pods might still be starting.
46+
It may take some time for the instance to be available especially during the provisioning phase.
47+
48+
== Find the connection details
49+
50+
The connection details are stored in a secret. You can retrieve them with the following command:
51+
52+
[source,bash]
53+
----
54+
$ oc get secrets forgejo-creds -o yaml
55+
----
56+
57+
The output of the command above is a secret specification with the following structure:
58+
59+
include::page$references/secrets.adoc[tag=forgejo]

‎docs/modules/ROOT/pages/vshn-managed/forgejo/index.adoc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
= VSHNForgejo (Forgejo)
2+
:toc: left
3+
:toclevels: 2
4+
5+
[WARNING]
6+
====
7+
VSHNForgejo is currently in alpha. This means that the service is still under active development and may undergo significant changes. Users should be aware that there may be bugs, incomplete features, and potential instability. We appreciate your feedback and encourage you to report any issues you encounter.
8+
====
9+
10+
Welcome to the documentation for Forgejo by VSHN. This page provides an overview of the software and its purpose.
11+
12+
== Introduction
13+
14+
Forgejo by VSHN, is a lightweight, managed Git service. It is designed to provide a simple, yet powerful platform for managing Git repositories, code review, and collaboration. Forgejo is built on the foundation of Gitea, an open-source Git service, but includes additional features and enhancements tailored to the needs of VSHN customers.
15+
16+
== Purpose
17+
18+
The primary purpose of Forgejo by VSHN is to offer a reliable and efficient Git hosting solution that can be easily deployed and managed. It aims to provide a seamless experience for developers and teams, enabling them to focus on their code and projects without worrying about the underlying infrastructure.
19+
20+
== Getting Started
21+
22+
To get started with Forgejo by VSHN, please refer to the following sections of the documentation:
23+
24+
* xref:vshn-managed/forgejo/create.adoc[Create a Forgejo instance]

0 commit comments

Comments
 (0)