Skip to content

Commit

Permalink
Merge branch 'main' into vultr-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fharper authored Jun 29, 2023
2 parents 71fd292 + b74f1a0 commit 14dfc10
Show file tree
Hide file tree
Showing 221 changed files with 4,197 additions and 172 deletions.
76 changes: 0 additions & 76 deletions .github/workflows/publish-preprod.yml

This file was deleted.

72 changes: 0 additions & 72 deletions .github/workflows/publish-prod.yml

This file was deleted.

File renamed without changes.
14 changes: 14 additions & 0 deletions docs/aws/gitops-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
hide_title: true
display_sidebar: aws
sidebar_label: GitOps Catalog
# custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
description: using the kubefirst gitops catalog
keywords:
- aws
image: 'https://docs.kubefirst.io/img/logo.svg'
---

import GitOpsCatalog from '@site/docs/common/gitops-catalog.mdx';

<GitOpsCatalog />
8 changes: 4 additions & 4 deletions docs/aws/quick-start/install/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ favorite git provider.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace kubefirst/kubefirst
helm install kubefirst --namespace kubefirst --create-namespace kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand All @@ -46,14 +46,14 @@ run on the ARM architecture.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace \
helm install kubefirst --namespace kubefirst --create-namespace \
--set=mongodb.image.repository=arm64v8/mongo \
--set=mongodb.image.tag=latest \
--set=mongodb.persistence.mountPath=/data/db \
--set=mongodb.extraEnvVarsSecret=kubefirst-initial-secrets \
kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand Down
14 changes: 14 additions & 0 deletions docs/civo/gitops-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
hide_title: true
display_sidebar: civo
sidebar_label: GitOps Catalog
# custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
description: using the kubefirst gitops catalog
keywords:
- aws
image: 'https://docs.kubefirst.io/img/logo.svg'
---

import GitOpsCatalog from '@site/docs/common/gitops-catalog.mdx';

<GitOpsCatalog />
8 changes: 4 additions & 4 deletions docs/civo/quick-start/install/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ favorite git provider.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace kubefirst/kubefirst
helm install kubefirst --namespace kubefirst --create-namespace kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand All @@ -46,14 +46,14 @@ run on the ARM architecture.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace \
helm install kubefirst --namespace kubefirst --create-namespace \
--set=mongodb.image.repository=arm64v8/mongo \
--set=mongodb.image.tag=latest \
--set=mongodb.persistence.mountPath=/data/db \
--set=mongodb.extraEnvVarsSecret=kubefirst-initial-secrets \
kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand Down
83 changes: 83 additions & 0 deletions docs/common/gitops-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# GitOps Catalog

After your kubefirst cluster has been provisioned, you can optionally leverage the Kubefirst GitOps Catalog.

The GitOps Catalog is a curated collection of Kubernetes applications that can be deployed directly to your kubefirst cluster(s).

For more information regarding applications that are generally available, check out the GitOps Catalog [repository](https://github.com/kubefirst/gitops-catalog).

## Using the catalog

After your cluster has been provisioned, you're able to click on a button to **open kubefirst console**:

![Cluster provision complete](../img/common/catalog/button.png)

Once this button has been clicked, you're presented with the **Services Overview** page:

![Services Overview page](../img/common/catalog/page.png)

This page shows the services that have been provisioned to your kubefirst management cluster. Default applications will show up in this list as well.

You can click on the **GitOps catalog** button to show the catalog:

![GitOps catalog](../img/common/catalog/services.png)

From here, you can click **Install** on any of the available services to deploy them to your cluster.

## How this works

When you opt to install any of the available services from the GitOps Catalog, the kubefirst API formats and commits a set of files to your gitops repository.

Then, Argo CD is asked to refresh the upstream registry to synchronize the newly deployed application.

Since the deployment of these applications is done directly in your gitops repository, you have full ownership to then customize these applications by adjusting their content within your gitops repository.

For example - consider the following sample deployment of Kuberntes Dashboard:

```yaml
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
name: kubernetes-dashboard
namespace: argocd
spec:
project: default
source:
repoURL: 'https://kubernetes.github.io/dashboard'
targetRevision: 6.0.0
chart: kubernetes-dashboard
destination:
server: 'https://kubernetes.default.svc'
namespace: kubernetes-dashboard
syncPolicy:
automated:
prune: true
selfHeal: true
syncOptions:
- CreateNamespace=true

---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
name: k8s-dashboard-clusterrole
annotations:
argocd.argoproj.io/sync-wave: '0'
subjects:
- kind: ServiceAccount
name: k8s-dashboard-sa
namespace: default
roleRef:
kind: ClusterRole
name: admin
apiGroup: rbac.authorization.k8s.io
---
apiVersion: v1
kind: ServiceAccount
metadata:
name: k8s-dashboard-sa
namespace: default
```
If you'd like to change any of the helm chart values, change the helm chart version, or add any additional resources, you simply edit this file and Argo CD will detect the changes from your upstream gitops repository and synchronize.
8 changes: 4 additions & 4 deletions docs/common/install-clouds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ favorite git provider.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace kubefirst/kubefirst
helm install kubefirst --namespace kubefirst --create-namespace kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand All @@ -38,14 +38,14 @@ run on the ARM architecture.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace \
helm install kubefirst --namespace kubefirst --create-namespace \
--set=mongodb.image.repository=arm64v8/mongo \
--set=mongodb.image.tag=latest \
--set=mongodb.persistence.mountPath=/data/db \
--set=mongodb.extraEnvVarsSecret=kubefirst-initial-secrets \
kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand Down
Binary file added docs/img/common/catalog/button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/common/catalog/page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/common/catalog/services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ const sidebars = {
},
],
},
'civo/gitops-catalog',
'aws/deprovision',
'aws/faq',
'aws/credits',
Expand All @@ -65,6 +66,7 @@ const sidebars = {
},
],
},
'civo/gitops-catalog',
'civo/deprovision',
'civo/faq',
'civo/credits',
Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-2.1/aws/quick-start/install/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ favorite git provider.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace kubefirst/kubefirst
helm install kubefirst --namespace kubefirst --create-namespace kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand All @@ -46,14 +46,14 @@ run on the ARM architecture.
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

helm install kubefirst --create-namespace \
helm install kubefirst --namespace kubefirst --create-namespace \
--set=mongodb.image.repository=arm64v8/mongo \
--set=mongodb.image.tag=latest \
--set=mongodb.persistence.mountPath=/data/db \
--set=mongodb.extraEnvVarsSecret=kubefirst-initial-secrets \
kubefirst/kubefirst

k port-forward svc/kubefirst-console 8080:8080
kubectl port-forward svc/kubefirst-console 8080:8080
```

Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080)
Expand Down
Loading

0 comments on commit 14dfc10

Please sign in to comment.