Skip to content
Open
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
28 changes: 14 additions & 14 deletions docs/platform/guides/account-management/kubernetes/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Supported Credential Types include:
- [Scaleway](#scaleway)
- [Vultr](#vultr)

Visit https://home.appscode.com/user/settings/credentials to manage credential.
Visit https://appscode.com/id/{user}/user/settings/credentials to manage credential.


## AWS
Expand Down Expand Up @@ -261,7 +261,7 @@ Details:
aws iam create-access-key --user-name "eks-cluster"
```

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create) you got from previous step.
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create) you got from previous step.

<img width="50%" src="images/aws-cred.png">

Expand All @@ -281,7 +281,7 @@ To configure Azure credentials for accessing and managing Azure Kubernetes Servi
- Save Credentials <br>
The command will output a JSON response containing the service principal details, including clientId (Application ID), clientSecret (Client Secret), subscriptionId, tenantId, and other information. Save these credentials securely as they will be used to configure the AKS cluster.

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).


<img align="right" width="50%" src="images/do-cred.png">
Expand All @@ -292,7 +292,7 @@ To access Digital Ocean Managed clusters, you need to create a API token from Di
Ref: [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/)


Then add the credential [here](https://home.appscode.com/user/settings/credentials/create) you got from Digital Ocean.
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create) you got from Digital Ocean.

<br><br><br><br>

Expand Down Expand Up @@ -322,14 +322,14 @@ To access GKE clusters, you need to create a GCP service account with with conta
--iam-account $GKE_SA_EMAIL
```

Then add the service account credentials [here](https://home.appscode.com/user/settings/credentials/create).
Then add the service account credentials [here](https://appscode.com/id/{user}/user/settings/credentials/create).

<img align="right" width="50%" src="images/gcp-oauth.png">

## Google OAuth

Simplest way to access GKE clusters is through creating `Google OAuth` type credential. <br>
Just head over [here](https://home.appscode.com/user/settings/credentials/create) and
Just head over [here](https://appscode.com/id/{user}/user/settings/credentials/create) and
- Choose a `Name`
- Select Credential Type: `Google OAuth`
- Click `Continue with Google`
Expand All @@ -349,15 +349,15 @@ To access LKE clusters, you need to create a API token from Linode with the foll
Ref: [Manage Linode Personal Access Tokens](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/)


Then add the credential [here](https://home.appscode.com/user/settings/credentials/create) you got from Linode.
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create) you got from Linode.

<br><br><br>

<img align="right" width="50%" src="images/rancher-cred.png">

## Rancher

To access Rancher clusters through AppsCode, you need to create an API token in your Rancher system. Follow these steps:
To access Rancher clusters through KubeDB Platform, you need to create an API token in your Rancher system. Follow these steps:

1. In Rancher, click on the profile icon.
2. Select `Account & API Keys`.
Expand All @@ -369,7 +369,7 @@ Reference: [Rancher API Keys](https://ranchermanager.docs.rancher.com/reference-

Copy the generated access key, secret key, and API endpoint from the `Account & API Keys` overview page.

Next, add these credentials to the [AppsCode user settings credentials page](https://home.appscode.com/user/settings/credentials/create).
Next, add these credentials to the [KubeDB Platform user settings credentials page](https://appscode.com/id/{user}/user/settings/credentials/create).

<img align="right" width="50%" src="../images/credentials/azureStorage.png">

Expand All @@ -380,7 +380,7 @@ To access Azure Blob Storage, you need your Storage Account name and one of its
- **Account:** Your Storage Account name, found in the Azure Portal under **Storage accounts**.
- **Key:** One of the access keys (key1 or key2), found under **Security + networking > Access keys** in the storage account sidebar. Click **Show** to reveal the key value.

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).

<br><br><br><br>

Expand All @@ -393,7 +393,7 @@ To access Cloudflare R2 Object Storage, you need your Account ID and an R2 API t
- **Account ID:** Found on your Cloudflare Dashboard under **R2 > Overview** or in the sidebar.
- **Access Key ID & Secret Access Key:** Generated by creating an R2 API token. Navigate to **R2 > Manage R2 API Tokens > Create API Token** and ensure the token has `Edit` permissions for the target bucket.

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).

<br><br><br><br>

Expand All @@ -408,7 +408,7 @@ To access Hetzner Cloud resources, you need an API token and an SSH key.

Ref: [Hetzner Cloud API Tokens](https://docs.hetzner.com/cloud/api/getting-started/generating-api-token/)

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).

<br><br><br>

Expand All @@ -423,7 +423,7 @@ To access Scaleway resources, you need your Organization ID and an API secret ke

Ref: [Scaleway API Keys](https://www.scaleway.com/en/docs/iam/api-keys/)

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).

<br><br><br>

Expand All @@ -437,4 +437,4 @@ To access Vultr resources, you need a Vultr API key.

Ref: [Vultr API](https://www.vultr.com/api/)

Then add the credential [here](https://home.appscode.com/user/settings/credentials/create).
Then add the credential [here](https://appscode.com/id/{user}/user/settings/credentials/create).
2 changes: 1 addition & 1 deletion docs/platform/guides/billing-and-usage-guide/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This document provides a detailed overview of the **Usage** section within our b

The AppsCode Billing Console is a web-based hub at [AppsCode Billing Console](https://appscode.com/billing) where you can manage contracts, link clusters, generate license-proxyserver installers, track licensed clusters, and **monitor usage—all in one place**.

This section focuses on the **Usage** dashboard, which shows the resources consumed by downstream AppsCode services like KubeDB running in your clusters.
This section focuses on the **Usage** dashboard, which shows the resources consumed by downstream KubeDB Platform services like KubeDB running in your clusters.

![usage-dashboard](../images/usage-section-home.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ menu:
identifier: guide-start
name: Get Started
parent: guides
description: Basic information and instructions for first-time users of AppsCode
description: Basic information and instructions for first-time users of KubeDB Platform
icon: https://img.icons8.com/00994A/ios/50/rocket--v1.png
popular: true
weight: 10
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/guides/get-started/add-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ section_menu_id: guides

# Add a Kubernetes Cluster

With your credentials in place, it's time to connect your Kubernetes cluster to the Platform Console. This step allows AppsCode to seamlessly manage and provide insights into your cluster.
With your credentials in place, it's time to connect your Kubernetes cluster to the Platform Console. This step allows KubeDB Platform to seamlessly manage and provide insights into your cluster.

Follow these steps to import your Kubernetes cluster:

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/guides/get-started/add-credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ section_menu_id: guides

# Add Credential

Now that you have successfully registered and logged in to the Platform Console, let's take the next step in setting up your environment. The first crucial task is to add credentials for your Kubernetes clusters. This ensures a secure connection and allows AppsCode to seamlessly manage your clusters.
Now that you have successfully registered and logged in to the Platform Console, let's take the next step in setting up your environment. The first crucial task is to add credentials for your Kubernetes clusters. This ensures a secure connection and allows KubeDB Platform to seamlessly manage your clusters.

Follow these steps to add your credentials:

1. Navigate to the [Add Credential Page](https://home.appscode.com/user/settings/credentials/create).
1. Navigate to the [Add Credential Page](https://appscode.com/id/{user}/user/settings/credentials/create).
2. Choose your `Credential Type` or authentication method and enter the required details.
3. Click on the `Done` button to securely save your credentials.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/guides/get-started/enable-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ section_menu_id: guides
# Enable Features


Once your cluster is imported, you can enable or disable AppsCode features based on your requirements.
Once your cluster is imported, you can enable or disable KubeDB Platform features based on your requirements.

1. Navigate to your Cluster Overview page, selecting your imported cluster in the [Platform Console](https://console.appscode.com/).
2. In the "Feature Sets" section, you'll find a list of FeatureSets associated with your cluster, along with their current status.
3. Click on any FeatureSet in the list to go to the FeatureSet Management page.
4. On the FeatureSet Management page, you can enable or disable specific features according to your needs.

Managing features in the Platform Console is a straightforward process that allows you to tailor your Platform Console to meet your cluster's requirements. Feel free to explore the features and capabilities offered by AppsCode.
Managing features in the Platform Console is a straightforward process that allows you to tailor your Platform Console to meet your cluster's requirements. Feel free to explore the features and capabilities offered by KubeDB Platform.

For more advanced configurations and detailed documentation, check out the [Features in Details](../cluster-management/cluster-features.md).
14 changes: 7 additions & 7 deletions docs/platform/guides/get-started/register-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ section_menu_id: guides
---


# Get Started with AppsCode
# Get Started with KubeDB Platform

## Register and Login

Welcome to AppsCode! This is a new version Follow these quick steps to get started:
Welcome to KubeDB Platform! This is a new version Follow these quick steps to get started:

### 1. Register for an Account

1. Navigate to the [AppsCode Registration Page](https://accounts.appscode.com/user/sign_up).
1. Navigate to the [KubeDB Platform Registration Page](https://accounts.appscode.com/user/sign_up).
2. Provide the following information:
- Username
- Email
Expand All @@ -33,14 +33,14 @@ Welcome to AppsCode! This is a new version Follow these quick steps to get start

### 2. Verify Your Email

After registration, check your email inbox for a verification email from AppsCode.
After registration, check your email inbox for a verification email from KubeDB Platform.

1. Open the verification email.
2. Click on the verification link to confirm your account.

### 3. Log In to AppsCode
### 3. Log In to KubeDB Platform

1. Once your account is verified, go to the [AppsCode Login Page](https://accounts.appscode.com/user/login).
1. Once your account is verified, go to the [KubeDB Platform Login Page](https://accounts.appscode.com/user/login).
2. Enter your registered `Username` or `Email Address` and `Password`.
3. Click on the `Sign In` button.
4. Optionally, you can sign in using your connected External accounts.
Expand All @@ -49,4 +49,4 @@ After registration, check your email inbox for a verification email from AppsCod

You are now logged in to the Platform Console! Take a moment to explore the features and navigate through the dashboard.

Congratulations! You have successfully registered, verified your email, and logged in to AppsCode. If you encounter any issues or have questions, refer to the [AppsCode Documentation](https://appscode.com/docs/) for detailed guidance.
Congratulations! You have successfully registered, verified your email, and logged in to KubeDB Platform. If you encounter any issues or have questions, refer to the [KubeDB Platform Documentation](https://appscode.com/docs/) for detailed guidance.
8 changes: 4 additions & 4 deletions docs/platform/guides/license-management/contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ section_menu_id: guides
## Contract

A contract is basically a digital agreement of the licensing relationship between AppsCode and its customers. Each contract represents a formal agreement for the use of
specific AppsCode products, such as KubeDB or platform-enterprise, with defined validity periods and feature sets.
specific KubeDB Platform products, such as KubeDB or platform-enterprise, with defined validity periods and feature sets.

The contract management system within the Billing Console provides comprehensive tools for creating, modifying, and monitoring contracts. Administrators can specify
product details, validity periods, and associated features, ensuring that customers have access to the appropriate resources for their needs.
Expand All @@ -23,7 +23,7 @@ product details, validity periods, and associated features, ensuring that custom

Key information typically contained within a contract includes:

- **Product:** The specific AppsCode product or bundle covered by the contract (e.g., `kubedb-enterprise`, `platform-enterprise` etc.).
- **Product:** The specific KubeDB Platform product or bundle covered by the contract (e.g., `kubedb-enterprise`, `platform-enterprise` etc.).
- **Org/User:** The organization or user account to which the contract is assigned.
- **Status:** The current state of the contract (e.g., active, expired, revoked), managed by AppsCode administrators.
- **Start Date:** The date from which the contract, and thus the license, becomes valid (not_before).
Expand All @@ -34,7 +34,7 @@ Contracts ensure that product usage is aligned with the purchased entitlements,

### Managing Cluster Associations with Contracts

For AppsCode products to operate with a valid license on a Kubernetes cluster, customers must explicitly associate that cluster with one or more active contracts
For KubeDB Platform products to operate with a valid license on a Kubernetes cluster, customers must explicitly associate that cluster with one or more active contracts
made available to them in the Billing Console. This capability is a key `self-service` feature, allowing customers to dynamically manage which of their Kubernetes
environments are licensed under a given contract, within the overall terms and capacity of that agreement.

Expand All @@ -58,7 +58,7 @@ To remove a cluster's authorization to use licensed products under a specific co
2. **Locate and Remove:** In the `Cluster` section, find the cluster in the associated clusters list that needs to be removed.
3. **Confirm Removal:** Select the `Remove` option (often represented by a `trash` icon) next to the cluster and confirm the action when prompted. ![Cluster Delete](../images/cluster-delete.png)

After removal, the cluster will no longer be authorized to use the licensed products associated with that contract. Any installed AppsCode products on that cluster may revert to their community or limited functionality, depending on their licensing model.
After removal, the cluster will no longer be authorized to use the licensed products associated with that contract. Any installed KubeDB Platform products on that cluster may revert to their community or limited functionality, depending on their licensing model.

**Audit Trail:** The Billing Console maintains an audit trail of changes to cluster associations, logging which user performed the action and when. This feature is vital for tracking, security, and troubleshooting. ![Audit Trail](../images/audits.png)

Expand Down
Loading