-
Notifications
You must be signed in to change notification settings - Fork 19
CloudCasa 1.3.0 #116
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.
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
CloudCasa 1.3.0 #116
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # CloudCasa Kubernetes Agent | ||
|
|
||
| [CloudCasa](https://cloudcasa.io) - Leader in Kubernetes Data Protection and Application Mobility | ||
|
|
||
| CloudCasa is a SaaS data protection, disaster recovery, migration, and replication solution for Kubernetes and cloud-native applications. | ||
| Configuration is quick and easy, and basic service is free. | ||
|
|
||
| This pack installs and configures the CloudCasa agent on a Kubernetes cluster. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.20 or above | ||
| - A CloudCasa account. You can [sign up](https://signup.cloudcasa.io/) for free. | ||
| - A CloudCasa **Cluster ID** (see below) | ||
|
|
||
| ## Parameters | ||
|
|
||
| To deploy the CloudCasa agent, you **must** set the `clusterID` parameter to the Cluster ID provided by CloudCasa. | ||
| All other parameters are optional or can be left at their default values. | ||
|
|
||
| | Key | Type | Default | Required | | ||
| |--- |--- |--- |--- | | ||
| | clusterID | string | `""` | Yes | | ||
| | image.repository | string | `"docker.io/catalogicsoftware/amds-kagent"` | Yes | | ||
| | image.tag | string | `"3.1.0-prod"` | Yes | | ||
| | imagePullSecret | string | `null` | No | | ||
|
|
||
| ## Usage | ||
|
|
||
| 1. Log in to https://home.cloudcasa.io and add your Kubernetes cluster under Clusters/Overview. Note the returned cluster ID. | ||
| 2. Install the pack, setting the `clusterID` parameter to the returned ID. | ||
|
|
||
| This will install the CloudCasa agent and complete registration of the cluster with the CloudCasa service. | ||
|
|
||
| ### Using an alternate image repository | ||
|
|
||
| The agent manager container can be installed from an alternate repository by setting values for image.repository and image.tag. | ||
| Note that the alternate repository will also need to be set for the cluster in CloudCasa so that all agent containers will be loaded from it. | ||
| See the [CloudCasa User Guide](https://docs.cloudcasa.io/help/cluster-add.html) for more information. | ||
|
|
||
| If the registry you are using requires authentication, you can define a Kubernetes secret with the authentication information | ||
| and reference it by setting a value for imagePullSecret. | ||
| See the [Kubernetes Docs](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) for more information. | ||
| Note that the secret name will also need to be set for the cluster in CloudCasa so that it will be used for all agent containers. | ||
| See the [CloudCasa User Guide](https://docs.cloudcasa.io/help/cluster-add.html) for more information. | ||
|
|
||
| ## References | ||
|
|
||
| - The CloudCasa Website: [https://cloudcasa.io](https://cloudcasa.io/) | ||
| - The CloudCasa [User Guide](https://docs.cloudcasa.io/help/) | ||
| - The CloudCasa [Getting Started Guide](https://cloudcasa.io/get-started) | ||
|
|
||
| *CloudCasa is a trademark of Catalogic Software, Inc.* | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,13 @@ | ||||||
| { | ||||||
| "name": "cloudcasa", | ||||||
| "version": "3.1.0", | ||||||
| "displayName": "CloudCasa Kubernetes Agent", | ||||||
| "annotations": { | ||||||
| "source": "community", | ||||||
| "contributor" : "catalogic" | ||||||
| }, | ||||||
| "layer": "addon", | ||||||
| "addonType": "system app", | ||||||
| "cloudTypes": [ "all" ], | ||||||
| "charts": [ "charts/cloudcasa-3.4.4.tgz" ] | ||||||
|
||||||
| "charts": [ "charts/cloudcasa-3.4.4.tgz" ] | |
| "charts": [ "charts/cloudcasa-3.1.0.tgz" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should these versions match?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, our agent and our Helm chart are versioned separately.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| pack: | ||
| # The namespace (on the target cluster) in which the pack will be deployed. | ||
| # When the namespace is not found, a new namespace will be created with the name specified. | ||
| # Note this namespace MUST NOT BE CHANGED from "cloudcasa-io". | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Include the content.images in the pack. Check other packs for examples. This should be the image or images needed for the pack to functions. This is how we use packs in airgap to bundle the images listed here.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks. Added. |
||
| namespace: "cloudcasa-io" | ||
| content: | ||
| images: | ||
| - image: docker.io/catalogicsoftware/amds-kagent:3.1.0-prod | ||
|
|
||
| charts: | ||
| cloudcasa: | ||
| # clusterID is the CloudCasa Cluster ID. To be provided by the user. | ||
| clusterID: "" | ||
|
|
||
| # image is the container repository and tag for the agent manager | ||
| image: | ||
| repository: "docker.io/catalogicsoftware/amds-kagent" | ||
| tag: "3.1.0-prod" | ||
|
|
||
| # imagePullSecret is the name of the secret to use for image registry credentials (optional) | ||
| imagePullSecret: | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any "Upgrade" specific notes? Add them as a section here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, there are really no additional notes necessary for upgrade.