diff --git a/README.md b/README.md index 07ab1a9..bee1863 100644 --- a/README.md +++ b/README.md @@ -7,32 +7,85 @@ This catalog repository holds all the Nutanix Products and their respective vers ## How to create catalog on your management cluster?
nkp create catalog nutanix-product-apps-catalog \ - -w## How to list all the catalogs on management cluster?\ - --branch \ + -w WORKSPACE_NAME \ + --branch CATALOG_RELEASE_BRANCH_NAME \ --url https://github.com/nutanix-cloud-native/nkp-nutanix-product-catalog
-kubectl get gitrepository -n-you can get workspace_namespace by running following command +you can get WORKSPACE_NAMESPACE by running following command+kubectl get gitrepository -n WORKSPACE_NAMESPACE
nkp get workspaces## How to list all the apps provided by added catalogs on management cluster?
-kubectl get apps -n## How to install catalog app? +To install catalog app say nutanix-ai on cluster CLUSTER_NAME, create following appDeployment instance+kubectl get apps -n WORKSPACE_NAMESPACE
+apiVersion: apps.kommander.d2iq.io/v1alpha3 +kind: AppDeployment +metadata: + name: APP_DEPLOYMENT_NAME + namespace: WORKSPACE_NAMESPACE +spec: + appRef: + kind: App + name: nutanix-ai-1.0.0 + clusterSelector: + matchExpressions: + - key: kommander.d2iq.io/cluster-name + operator: In + values: + - CLUSTER_NAME + configOverrides: + name: nutanix-ai-1-config-overrides ++ +you can create following configmap to pass the helm values to the nutanix-ai helm chart +
+apiVersion: v1 +data: + values.yaml: | + imagePullSecret: + # Name of the image pull secret + name: nai-iep-secret + # Image registry credentials + credentials: + registry: https://index.docker.io/v1/ + username: USERNAME + password: PASSWORD + email: EMAIL + naiApi: + # NAI API image details + naiApiImage: + # The name of the NAI API Docker image + image: docker.io/nutanix/nai-api + # The tag of the Docker image to be used + tag: v1.0.0-rc2 + storageClassName: nai-nfs-storage +kind: ConfigMap +metadata: + name: nutanix-ai-1-config-overrides + namespace: WORKSPACE_NAMESPACE ++pre and post steps for this app can be found in the rerspective app's metadata.yaml overview yaml node. + +## How to Uninstall catalog app? +On management cluster, run following: +
+kubectl delete appDeployment APP_DEPLOYMENT_NAME -n WORKSPACE_NAMESPACE## How to delete catalog from your management cluster?
-kubectl delete gitrepository nutanix-product-apps-catalog -nFor more details, you can refer to Nutanix Portal for Nutanix Kubernetes Platform documentation. \ No newline at end of file+kubectl delete gitrepository nutanix-product-apps-catalog -n WORKSPACE_NAMESPACE