diff --git a/config.dev.yaml b/config.dev.yaml index 4bf0bbcc8..5e905aa66 100644 --- a/config.dev.yaml +++ b/config.dev.yaml @@ -18,10 +18,10 @@ params: domain_pharmer: https://pharmer-v1-hugo.web.app domain_kubeci: https://kubeci-v1-hugo.web.app domain_kubeshield: https://kubeshield-v1-hugo.web.app - domain_bytebuilders: https://byte.builders - domain_marketplace: https://marketplace.byte.builders + domain_bytebuilders: https://appscode.com + domain_marketplace: https://marketplace.appscode.com search_api_key: 8fd610038d901dd16a111e6f1568343bb969b084a1952dafdcb1545fd8c35e96 - blog_url: https://blog.byte.builders + blog_url: https://blog.appscode.com slack_url: https://slack.appscode.com github_url: https://github.com/appscode twitter_url: https://twitter.com/AppsCodeHQ diff --git a/config.yaml b/config.yaml index fc25f43b5..add2946de 100644 --- a/config.yaml +++ b/config.yaml @@ -18,10 +18,10 @@ params: domain_pharmer: https://pharmer.dev domain_kubeci: https://kube.ci domain_kubeshield: https://kubeshield.com - domain_bytebuilders: https://byte.builders - domain_marketplace: https://marketplace.byte.builders + domain_bytebuilders: https://appscode.com + domain_marketplace: https://marketplace.appscode.com search_api_key: 8fd610038d901dd16a111e6f1568343bb969b084a1952dafdcb1545fd8c35e96 - blog_url: https://blog.byte.builders + blog_url: https://blog.appscode.com slack_url: https://slack.appscode.com github_url: https://github.com/appscode twitter_url: https://twitter.com/AppsCodeHQ diff --git a/content/docs/v2023.9.18/guides/ingress/configuration/custom-templates.md b/content/docs/v2023.9.18/guides/ingress/configuration/custom-templates.md index 092025342..eec757ce8 100644 --- a/content/docs/v2023.9.18/guides/ingress/configuration/custom-templates.md +++ b/content/docs/v2023.9.18/guides/ingress/configuration/custom-templates.md @@ -57,10 +57,12 @@ $ kubectl create configmap -n voyager voyager-templates --from-file=/tmp/default Now, the ConfigMap `voyager-templates` has to be mounted in the voyager operator pod and `--custom-templates` flag has to be set. To do this, set `templates.cfgmap` value to Voyager operator chart. ```bash -$ helm install voyager appscode/voyager --version {{< param "info.version" >}} \ - --namespace voyager \ +$ helm install voyager oci://ghcr.io/appscode-charts/voyager \ + --version {{< param "info.version" >}} \ + --namespace voyager --create-namespace \ --set cloudProvider=minikube \ - --set templates.cfgmap=voyager-templates + --set templates.cfgmap=voyager-templates \ + --wait --burst-limit=10000 --debug ``` ![installer](/docs/v2023.9.18/images/ingress/configuration/custom-template/installer.png) diff --git a/content/docs/v2023.9.18/setup/README.md b/content/docs/v2023.9.18/setup/README.md index c5be0a0b9..fcffb2e41 100644 --- a/content/docs/v2023.9.18/setup/README.md +++ b/content/docs/v2023.9.18/setup/README.md @@ -22,19 +22,17 @@ info: # Setup
- Install Community Edition - Try Enterprise Edition - Compare Editions + Install Voyager

The setup section contains instructions for installing the Voyager and its various components in Kubernetes. This section has been divided into the following sub-sections: - **Install Voyager:** Installation instructions for Voyager and its various components. - - [Community Edition](/docs/v2023.9.18/setup/install/community): Installation instructions for Voyager Community Edition. - - [Enterprise Edition](/docs/v2023.9.18/setup/install/enterprise): Installation instructions for Voyager Enterprise Edition. + - [Voyager](/docs/v2023.9.18/setup/install/voyager): Installation instructions for Voyager. - [Troubleshooting](/docs/v2023.9.18/setup/install/troubleshooting): Troubleshooting guide for various installation problems. + - **Uninstall Voyager:** Uninstallation instructions for Voyager and its various components. - - [Community Edition](/docs/v2023.9.18/setup/uninstall/community): Uninstallation instructions for Voyager Community Edition. - - [Enterprise Edition](/docs/v2023.9.18/setup/uninstall/enterprise): Uninstallation instructions for Voyager Enterprise Edition. + - [Voyager](/docs/v2023.9.18/setup/uninstall/voyager): Uninstallation instructions for Voyager. + - [Upgrading Voyager](/docs/v2023.9.18/setup/upgrade/): Instruction for updating Voyager license and upgrading between various Voyager versions. diff --git a/content/docs/v2023.9.18/setup/install/community.md b/content/docs/v2023.9.18/setup/install/community.md deleted file mode 100644 index 40459269c..000000000 --- a/content/docs/v2023.9.18/setup/install/community.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Install Voyager Community Edition -description: Installation guide for Voyager Community edition -menu: - docs_v2023.9.18: - identifier: install-voyager-operator - name: Community Edition - parent: installation-guide - weight: 10 -product_name: voyager -menu_name: docs_v2023.9.18 -section_menu_id: setup -info: - cli: v0.0.14 - installer: v2023.9.18 - version: v2023.9.18 ---- - -# Install Voyager Community Edition - -Voyager Community edition is available under [AppsCode-Community-1.0.0](https://github.com/appscode/licenses/raw/1.0.0/AppsCode-Community-1.0.0.md) license and free to use for both commercial and non-commercial purposes. `Community Edition` only manages Voyager custom resources in the `demo` Kubernetes namespace. A full features comparison between the Voyager Community edition and Enterprise edition can be found [here](https://voyagermesh.com/pricing/). - -To use the Voyager Community edition, you can grab **1 year** free license from [here](https://license-issuer.appscode.com/?p=voyager-community). After that, you can issue another license for one more year. Typically we release a new version of the operator at least quarterly. So, you can just grab a new license every time you upgrade the operator. - -## Get a License - -In this section, we are going to show you how you can get a **1 year** free license for the Voyager Community edition. You can get a license for your Kubernetes cluster by going through the following steps: - -- At first, go to [AppsCode License Server](https://license-issuer.appscode.com/?p=voyager-community) and fill-up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). -- Provide your name and email address. You can provide your personal or work email address. -- Then, select `Voyager Community Edition` in the product field. -- Now, provide your cluster-ID. You can get your cluster ID easily by running the following command: - - ```bash - $ kubectl get ns kube-system -o=jsonpath='{.metadata.uid}' - ``` - -- Then, you have to agree with the terms and conditions. We recommend reading it before checking the box. -- Now, you can submit the form. After you submit the form, the AppsCode License server will send an email to the provided email address with a link to your license file. -- Navigate to the provided link and save the license into a file. Here, we save the license to a `license.txt` file. - -Here is a screenshot of the license form. - -
- Voyager License Form -
Fig: Voyager License Form
-
- -You can create licenses for as many clusters as you want. You can upgrade your license any time without re-installing Voyager by following the upgrading guide from [here](/docs/v2023.9.18/setup/upgrade/#updating-license). - -> Voyager licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from [here](https://github.com/appscode/offline-license-server#api-reference). - -## Install - -Voyager operator can be installed as a Helm chart or simply as Kubernetes manifests. - - -
-
- -## Using Helm 3 - -Voyager can be installed via [Helm](https://helm.sh/) using the [chart](https://github.com/voyagermesh/installer/tree/{{< param "info.version" >}}/charts/voyager) from [AppsCode Charts Repository](https://github.com/appscode/charts). To install, follow the steps below: - -```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update - -$ helm search repo appscode/voyager --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/voyager {{< param "info.version" >}} {{< param "info.version" >}} Voyager by AppsCode - Secure L7/L4 Ingress Cont... -appscode/voyager-crds {{< param "info.version" >}} {{< param "info.version" >}} Voyager Custom Resource Definitions - -# provider=acs -# provider=aks -# provider=aws -# provider=azure -# provider=baremetal -# provider=gce -# provider=gke -# provider=kind -# provider=openstack -# provider=metallb -# provider=digitalocean -# provider=linode - -$ helm install voyager appscode/voyager \ - --version {{< param "info.version" >}} \ - --namespace voyager --create-namespace \ - --set cloudProvider=$provider \ - --set-file license=/path/to/the/license.txt -``` - -To see the detailed configuration options, visit [here](https://github.com/voyagermesh/installer/tree/{{< param "info.version" >}}/charts/voyager). - -
-
- -## Using YAML - -If you prefer to not use Helm, you can generate YAMLs from Voyager chart and deploy using `kubectl`. Here we are going to show the procedure using Helm 3. - -```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update - -$ helm search repo appscode/voyager --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/voyager {{< param "info.version" >}} {{< param "info.version" >}} Voyager by AppsCode - Secure L7/L4 Ingress Cont... -appscode/voyager-crds {{< param "info.version" >}} {{< param "info.version" >}} Voyager Custom Resource Definitions - -# provider=acs -# provider=aks -# provider=aws -# provider=azure -# provider=baremetal -# provider=gce -# provider=gke -# provider=kind -# provider=openstack -# provider=metallb -# provider=digitalocean -# provider=linode - -$ kubectl create ns voyager -$ helm template voyager appscode/voyager \ - --version {{< param "info.version" >}} \ - --namespace voyager \ - --set cloudProvider=$provider \ - --set-file license=/path/to/the/license.txt \ - --set cleaner.skip=true | kubectl apply -f - -``` - -To see the detailed configuration options, visit [here](https://github.com/voyagermesh/installer/tree/{{< param "info.version" >}}/charts/voyager). - -
-
- -## Verify installation - -To check if Voyager operator pods have started, run the following command: - -```bash -$ kubectl get pods --all-namespaces -l app.kubernetes.io/name=voyager --watch - -NAMESPACE NAME READY STATUS RESTARTS AGE -voyager voyager-operator-84d575d55-5lphm 1/1 Running 0 6m42s -``` - -Once the operator pods are running, you can cancel the above command by typing `Ctrl+C`. - -Now, to confirm CRD groups have been registered by the operator, run the following command: - -```bash -$ kubectl get crd -l app.kubernetes.io/name=voyager -``` - -Now, you are ready to create your first ingress using Voyager. - - -## Configuring RBAC - -Voyager creates an `Ingress` CRD. Voyager installer will create 2 user facing cluster roles: - -| ClusterRole | Aggregates To | Description | -|-----------------------|---------------|---------------------------------------| -| appscode:voyager:edit | admin, edit | Allows edit access to Voyager CRDs, intended to be granted within a namespace using a RoleBinding. | -| appscode:voyager:view | view | Allows read-only access to Voyager CRDs, intended to be granted within a namespace using a RoleBinding. | - -These user facing roles supports [ClusterRole Aggregation](https://kubernetes.io/docs/admin/authorization/rbac/#aggregated-clusterroles) feature in Kubernetes 1.9 or later clusters. - - -## Using kubectl - -Since Voyager uses its own TPR/CRD, you need to use full resource kind to find it with kubectl. - -```bash -# List all voyager ingress -$ kubectl get ingress.voyager.appscode.com --all-namespaces - -# List voyager ingress for a namespace -$ kubectl get ingress.voyager.appscode.com -n - -# Get Ingress YAML -$ kubectl get ingress.voyager.appscode.com -n -o yaml - -# Describe Ingress. Very useful to debug problems. -$ kubectl describe ingress.voyager.appscode.com -n -``` diff --git a/content/docs/v2023.9.18/setup/install/enterprise.md b/content/docs/v2023.9.18/setup/install/voyager.md similarity index 64% rename from content/docs/v2023.9.18/setup/install/enterprise.md rename to content/docs/v2023.9.18/setup/install/voyager.md index 968a054c4..a0810205c 100644 --- a/content/docs/v2023.9.18/setup/install/enterprise.md +++ b/content/docs/v2023.9.18/setup/install/voyager.md @@ -1,10 +1,10 @@ --- -title: Install Voyager Enterprise Edition -description: Installation guide for Voyager Enterprise edition +title: Install Voyager +description: Installation guide for Voyager menu: docs_v2023.9.18: identifier: install-voyager-enterprise - name: Enterprise Edition + name: Voyager parent: installation-guide weight: 20 product_name: voyager @@ -16,19 +16,15 @@ info: version: v2023.9.18 --- -# Install Voyager Enterprise Edition +# Install Voyager -Voyager Enterprise edition is the open core version of [Voyager](https://github.com/voyagermesh). `Enterprise Edition` can be used to manage Voyager custom resources in any Kubernetes namespace. A full features comparison between the Voyager Community edition and Enterprise edition can be found [here](https://voyagermesh.com/pricing/). +## Get a Free Trial License -If you are willing to try Voyager Enterprise Edition, you can grab a **30 days trial** license from [here](https://license-issuer.appscode.com/?p=voyager-enterprise). To purchase an Enterprise license, please contact us from [here](https://appscode.com/contact). +In this section, we are going to show you how you can get a **30 days trial** license for Voyager. You can get a license for your Kubernetes cluster by going through the following steps: -## Get a Trial License - -In this section, we are going to show you how you can get a **30 days trial** license for Voyager Enterprise edition. You can get a license for your Kubernetes cluster by going through the following steps: - -- At first, go to [AppsCode License Server](https://license-issuer.appscode.com/?p=voyager-enterprise) and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). +- At first, go to [AppsCode License Server](https://appscode.com/issue-license?p=voyager) and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). - Provide your name and email address. **You must provide your work email address**. -- Then, select `Voyager Enterprise Edition` in the product field. +- Then, select `Voyager` in the product field. - Now, provide your cluster ID. You can get your cluster ID easily by running the following command: ```bash @@ -50,16 +46,14 @@ You can create licenses for as many clusters as you want. You can upgrade your l > Voyager licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from [here](https://github.com/appscode/offline-license-server#api-reference). -## Get an Enterprise License +## Purchase Voyager License -If you are interested in purchasing Enterprise license, please contact us via sales@appscode.com for further discussion. You can also set up a meeting via our [calendly link](https://calendly.com/appscode/30min). +If you are interested in purchasing Voyager license, please contact us via sales@appscode.com for further discussion. You can also set up a meeting via our [calendly link](https://calendly.com/appscode/30min). -If you are willing to purchasing Enterprise license but need more time to test in your dev cluster, feel free to contact sales@appscode.com. We will be happy to extend your trial period. +If you are willing to purchase Voyager license but need more time to test in your dev cluster, feel free to contact sales@appscode.com. We will be happy to extend your trial period. ## Install -To activate the Enterprise features, you need to install both Voyager Community operator and Enterprise operator chart. These operators can be installed as a Helm chart or simply as Kubernetes manifests. If you have already installed the Community operator, only install the Enterprise operator (step 4 in the following section). -