-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(redux) add K8sJobRunnerSrv, which runs Cortex jobs using Kubernetes …
…Jobs
- Loading branch information
1 parent
619a70f
commit 009c997
Showing
8 changed files
with
179 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package org.thp.cortex.services | ||
|
|
||
| import java.util.concurrent.TimeUnit | ||
| import java.nio.file._ | ||
|
|
||
| import scala.concurrent.duration.FiniteDuration | ||
| import scala.util.{Try} | ||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import play.api.{Configuration, Logger} | ||
|
|
||
| import akka.actor.ActorSystem | ||
| import io.fabric8.kubernetes.client.{DefaultKubernetesClient} | ||
| import io.fabric8.kubernetes.api.model.batch.{JobBuilder => KJobBuilder} | ||
| import io.fabric8.kubernetes.api.model.{PersistentVolumeClaimVolumeSourceBuilder} | ||
| import javax.inject.{Inject, Singleton} | ||
| import org.thp.cortex.models._ | ||
|
|
||
| @Singleton | ||
| class K8sJobRunnerSrv( | ||
| client: DefaultKubernetesClient, | ||
| config: Configuration, | ||
| autoUpdate: Boolean, | ||
| jobBaseDirectory: Path, | ||
| persistentVolumeClaimName: String, | ||
| implicit val system: ActorSystem | ||
| ) { | ||
|
|
||
| @Inject() | ||
| def this(config: Configuration, system: ActorSystem) = | ||
| this( | ||
| new DefaultKubernetesClient(), | ||
| config, | ||
| config.getOptional[Boolean]("job.kubernetes.autoUpdate").getOrElse(true), | ||
| Paths.get(config.get[String]("job.directory")), | ||
| config.get[String]("job.kubernetes.persistentVolumeClaimName"), | ||
| system: ActorSystem | ||
| ) | ||
|
|
||
| lazy val logger = Logger(getClass) | ||
|
|
||
| lazy val isAvailable: Boolean = | ||
| Try { | ||
| val ver = client.getVersion() | ||
| logger.info(s"Kubernetes is available: major ${ver.getMajor()} minor ${ver.getMinor()} git ${ver.getGitCommit()}") | ||
| true | ||
| }.recover { | ||
| case error => | ||
| logger.info(s"Kubernetes is not available", error) | ||
| false | ||
| }.get | ||
|
|
||
| def run(jobDirectory: Path, dockerImage: String, job: Job, timeout: Option[FiniteDuration]): Try[Unit] = { | ||
| val cacertsFile = jobDirectory.resolve("input").resolve("cacerts") | ||
| val relativeJobDirectory = jobBaseDirectory.relativize(jobDirectory).toString() | ||
| // make the default longer than likely values, but still not infinite | ||
| val timeout_or_default = timeout getOrElse new FiniteDuration(8, TimeUnit.HOURS) | ||
| // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ | ||
| // FIXME: this collapses case, jeopardizing the uniqueness of the | ||
| // identifier. LDH: lowercase, digits, hyphens. | ||
| val ldh_jobid = "_".r.replaceAllIn(job.id.map(_.toLower), "-") | ||
| val kjobName = "neuron-job-" + ldh_jobid | ||
| val pvcvs = new PersistentVolumeClaimVolumeSourceBuilder() | ||
| .withClaimName(persistentVolumeClaimName) | ||
| .withReadOnly(false) | ||
| .build(); | ||
| val kjob1 = new KJobBuilder() | ||
| .withApiVersion("batch/v1") | ||
| .withNewMetadata() | ||
| .withName(kjobName) | ||
| .withLabels(Map( | ||
| "cortex-job-id" -> job.id, | ||
| "cortex-worker-id" -> job.workerId(), | ||
| "cortex-neuron-job" -> "true").asJava) | ||
| .endMetadata() | ||
| .withNewSpec() | ||
| .withNewTemplate() | ||
| .withNewSpec() | ||
| .addNewVolume() | ||
| .withName("job-directory") | ||
| .withPersistentVolumeClaim(pvcvs) | ||
| .endVolume() | ||
| .addNewContainer() | ||
| .withName("neuron") | ||
| .withImage(dockerImage) | ||
| .withArgs("/job") | ||
| .addNewEnv() | ||
| .withName("CORTEX_JOB_FOLDER") | ||
| .withValue(relativeJobDirectory) | ||
| .endEnv(); | ||
| val kjob2 = if (Files.exists(cacertsFile)) { | ||
| kjob1.addNewEnv() | ||
| .withName("REQUESTS_CA_BUNDLE") | ||
| .withValue("/job/input/cacerts") | ||
| .endEnv() | ||
| } else { | ||
| kjob1 | ||
| } | ||
| val kjob3 = kjob2 | ||
| .addNewVolumeMount() | ||
| .withName("job-directory") | ||
| .withSubPathExpr("$(CORTEX_JOB_FOLDER)/input") | ||
| .withMountPath("/job/input") | ||
| .withReadOnly(true) | ||
| .endVolumeMount() | ||
| .addNewVolumeMount() | ||
| .withName("job-directory") | ||
| .withSubPathExpr("$(CORTEX_JOB_FOLDER)/output") | ||
| .withMountPath("/job/output") | ||
| .withReadOnly(false) | ||
| .endVolumeMount() | ||
| .endContainer() | ||
| .withRestartPolicy("Never") | ||
| .endSpec() | ||
| .endTemplate() | ||
| .endSpec() | ||
| .build(); | ||
|
|
||
| val execution = Try { | ||
| val created_kjob = client.batch().jobs().create(kjob3) | ||
| val created_env = created_kjob | ||
| .getSpec().getTemplate().getSpec().getContainers().get(0) | ||
| .getEnv().asScala; | ||
| logger.info( | ||
| s"Created Kubernetes Job ${created_kjob.getMetadata().getName()}\n" + | ||
| s" timeout: ${timeout_or_default.toString}\n" + | ||
| s" image : $dockerImage\n" + | ||
| s" mount : pvc ${persistentVolumeClaimName} subdir ${relativeJobDirectory} as /job" + | ||
| created_env.map(ev => s"\n env : ${ev.getName()} = ${ev.getValue()}").mkString) | ||
| val ended_kjob = client.batch().jobs().withLabel("cortex-job-id", job.id) | ||
| .waitUntilCondition((x => Option(x).flatMap(j => | ||
| Option(j.getStatus).flatMap(s => | ||
| Some(s.getConditions.asScala.map(_.getType).filter(t => | ||
| t.equals("Complete") || t.equals("Failed")).nonEmpty))) | ||
| getOrElse false), | ||
| timeout_or_default.length, timeout_or_default.unit); | ||
| if(ended_kjob != null) { | ||
| logger.info(s"Kubernetes Job ${ended_kjob.getMetadata().getName()} " + | ||
| s"(for job ${job.id}) status is now ${ended_kjob.getStatus().toString()}") | ||
| } else { | ||
| logger.info(s"Kubernetes Job for ${job.id} no longer exists") | ||
| } | ||
| } | ||
| // let's find the job by the attribute we know is fundamentally | ||
| // unique, rather than one constructed from it | ||
| val deleted = client.batch().jobs().withLabel("cortex-job-id", job.id).delete() | ||
| if(deleted) { | ||
| logger.info(s"Deleted Kubernetes Job for job ${job.id}") | ||
| } else { | ||
| logger.info(s"While trying to delete Kubernetes Job for ${job.id}, the job was not found; this is OK") | ||
| } | ||
| execution | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters