dongjoon-hyun commented on code in PR #113: URL: https://github.com/apache/spark-kubernetes-operator/pull/113#discussion_r1762265952
########## docs/spark_custom_resources.md: ########## @@ -0,0 +1,203 @@ +## Spark Operator API + +The core user facing API of the Spark Kubernetes Operator is the `SparkApplication` and +`SparkCluster` Custom Resources Definition (CRD). Spark custom resource extends +standard k8s API, defines Spark Application spec and tracks status. + +Once the Spark Operator is installed and running in your Kubernetes environment, it will +continuously watch SparkApplication(s) and SparkCluster(s) submitted, via k8s API client or +kubectl by the user, orchestrate secondary resources (pods, configmaps .etc). + +Please check out the [quickstart](../README.md) as well for installing operator. + +## SparkApplication + +SparkApplication can be defined in YAML format and with bare minimal required fields in +order to start: + +``` +apiVersion: spark.apache.org/v1alpha1 +kind: SparkApplication +metadata: + name: pi +spec: + mainClass: "org.apache.spark.examples.SparkPi" + jars: "local:///opt/spark/examples/jars/spark-examples_2.13-4.0.0-preview1.jar" + sparkConf: + spark.executor.instances: "5" + applicationTolerations: + resourceRetainPolicy: OnFailure + runtimeVersions: + scalaVersion: "2.13" + sparkVersion: "4.0.0-preview1" + Review Comment: Redundant empty link. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
