Skip to content
This repository was archived by the owner on Oct 27, 2022. It is now read-only.

fix default build mechanism priority for jib (address #7) #28

Open
SaketramDurbha wants to merge 4 commits into
base: master
Choose a base branch
from
Open

fix default build mechanism priority for jib (address #7) #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cac73a0
reasonable defaults: prefer jib for all java-based samples, regardles…
Aug 10, 2020
f4f6665
minor documentation and logging update
Aug 18, 2020
733e04f
refactor README.md format
Aug 20, 2020
7e37404
fix README.md typo
Aug 20, 2020
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
30 changes: 26 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Authenticate gcloud with your user account:
gcloud auth login
```

Consider setting defaults for Cloud Run operations, such as setting the region:
Set defaults for Cloud Run operations, such as setting the region:
```bash
gcloud config set run/region us-central1
gcloud config set run/platform managed
Expand All @@ -34,6 +34,14 @@ Run Serverless Sample Tester by passing in the root directory of the sample you
./sst [target-dir]
```

## Build and Deploying Your Sample
This program allows you to specify how you would like it to build and deploy your sample to Cloud Run, fully managed,
in two ways. From highest to lowest, this program uses the following precedence order to find your build and deploy
instructions:

1. README parsing
1. Defaults

### README parsing
To parse build and deploy commands from your sample's README, include the following comment code tag before each gcloud command:

Expand All @@ -50,9 +58,9 @@ gcloud builds submit --tag=gcr.io/${GOOGLE_CLOUD_PROJECT}/run-mysql
````
In the absence of a README, the tool will fall back on reasonable defaults based on whether the sample is Java-based and/or has a Dockerfile.

## Configuration and Implementation
#### Configuration and Implementation

### README location
#### README location
For parsing the README, the tool assumes that it is located in the target directory. If you wish to parse a README file located elsewhere, you can include the README's location
in a `config.yaml` file in the target directory, using the key `readme`. You can specify an absolute directory, or you can simply
specify a directory relative to the sample's directory.
Expand All @@ -62,7 +70,7 @@ For example, if the README is in the parent directory of the sample:
readme: ../README.md
```

### Parsing rules
#### Parsing rules
No parsed commands are run through a shell, meaning that the tool will not perform any typical expansions, pipelines, redirections, or other functions. This also means that popular shell builtin commands like `cd`, `export`, `echo`, and
others may not work as expected.

Expand All @@ -79,3 +87,17 @@ what the name is, but it may not always be accurate. For example, if your README
gcloud run deploy run-mysql --image gcr.io/[YOUR_PROJECT_ID]/run-mysql
```
then `$CLOUD_RUN_SERVICE_NAME` should be set to `run-mysql`.


### Defaults
If comment code tags aren't added to your README, the program will fall back to reasonable defaults to build and deploy
your sample to Cloud Run based on whether your sample is Java-based (has a pom.xml) or not.

If your sample is Java-based, your sample will be built and pushed to the Container Registry using
`mvn compile com.google.cloud.tools:jib-maven-plugin:2.0.0:build -Dimage=[image_tag]`.

Otherwise, your sample will be built and pushed to the Container Registry using
`gcloud builds submit --tag=[image_tag]`.

In both cases, `gcloud run deploy --image=[image_tag] --platform=managed`, will be used to deploy the container image to
Cloud Run.
15 changes: 5 additions & 10 deletions internal/lifecycle/lifecycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ func (l Lifecycle) Execute(commandsDir string) error {
}

// NewLifecycle tries to parse the different options provided for build and deploy command configuration. If none of
// those options are set up, it falls back to reasonable defaults based on whether the sample is java-based
// (has a pom.xml) that doesn't have a Dockerfile or isn't.
// those options are set up, it falls back to reasonable defaults based on whether the sample is Java-based
// (has a pom.xml) or not.
func NewLifecycle(sampleDir, serviceName, gcrURL string) (Lifecycle, error) {
var readmePath string
// Searching for config file
Expand Down Expand Up @@ -77,20 +77,15 @@ func NewLifecycle(sampleDir, serviceName, gcrURL string) (Lifecycle, error) {
}

pomPath := filepath.Join(sampleDir, "pom.xml")
dockerfilePath := filepath.Join(sampleDir, "Dockerfile")

_, err := os.Stat(pomPath)
pomE := err == nil

_, err = os.Stat(dockerfilePath)
dockerfileE := err == nil

if pomE && !dockerfileE {
log.Println("Using default build and deploy commands for java samples without a Dockerfile")
if pomE {
log.Println("Using default build and deploy commands for Java samples")
return buildDefaultJavaLifecycle(serviceName, gcrURL), nil
}

log.Println("Using default build and deploy commands for non-java samples or java samples with a Dockerfile")
log.Println("Using default build and deploy commands for non-Java samples")
return buildDefaultLifecycle(serviceName, gcrURL), nil
}

Expand Down