qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-05 14:56:10 -07:00
Code Releases Activity
e5fe289229
go/cmd/godoc
History
Brad Fitzpatrick e5fe289229 godoc, cmd/godoc: remove CLI support 
godoc is now just a webserver (the one that runs golang.org)

A future change might rename this to something else, but not now.

Fixes golang/go#25443

Change-Id: Ib95d0589e13f4c7a717ff28d694f1472e427eef4
Reviewed-on: https://go-review.googlesource.com/c/141397
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Andrew Gerrand <adg@golang.org>
2018-10-11 02:31:40 +00:00
..
.gitignore cmd/godoc: simplify dev and prod environment for App Engine 2018-09-28 11:54:07 +00:00
app.dev.yaml cmd/godoc: simplify dev and prod environment for App Engine 2018-09-28 11:54:07 +00:00
app.prod.yaml cmd/godoc: re-enable host checking, allow test versions 2018-10-03 01:52:03 +00:00
appinit.go godoc, cmd/godoc: remove CLI support 2018-10-11 02:31:40 +00:00
autocert.go cmd/godoc: support http-01 ACME challenge in optional autocert support 2018-04-11 21:25:11 +00:00
blog.go cmd/godoc: redirect to https instead of http for blog.golang.org 2018-08-22 02:22:54 +00:00
cloudbuild.yaml cmd/godoc: add cloud build config 2018-10-04 02:18:13 +00:00
codewalk.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
dl.go godoc: migrate to App Engine flexible 2018-10-02 04:34:10 +00:00
doc.go cmd/godoc: Fix package comment inconsistencies. 2017-03-04 00:53:44 +00:00
Dockerfile.prod cmd/godoc: add missing Dockerfile ARG 2018-10-10 15:29:03 +00:00
generate-index.bash godoc: migrate to App Engine flexible 2018-10-02 04:34:10 +00:00
godoc_test.go godoc, cmd/godoc: remove CLI support 2018-10-11 02:31:40 +00:00
goroot.go cmd/godoc: use same GOROOT discovery as Go 1.10's cmd/go 2018-06-12 01:24:34 +00:00
handlers.go godoc, cmd/godoc: remove CLI support 2018-10-11 02:31:40 +00:00
hg-git-mapping.bin godoc: migrate to App Engine flexible 2018-10-02 04:34:10 +00:00
index.go cmd/godoc: exclude /pkg from search indexing 2015-03-12 00:26:38 +00:00
main.go godoc, cmd/godoc: remove CLI support 2018-10-11 02:31:40 +00:00
Makefile cmd/godoc: add cloud build config 2018-10-04 02:18:13 +00:00
play.go godoc: migrate to App Engine flexible 2018-10-02 04:34:10 +00:00
README.godoc-app cmd/godoc: add cloud build config 2018-10-04 02:18:13 +00:00
regtest_test.go cmd/godoc: add version info for golang.org 2018-10-06 00:25:42 +00:00
x.go godoc/static: add perf, review, sync subrepos 2018-03-30 16:45:20 +00:00

README.godoc-app 

godoc on Google App Engine
==========================

Prerequisites
-------------

* Google Cloud SDK
  https://cloud.google.com/sdk/

* Redis

* Go sources under $GOROOT

* Godoc sources inside $GOPATH
  (go get -d golang.org/x/tools/cmd/godoc)


Running locally, in production mode
-----------------------------------

Build the app:

  go build -tags golangorg

Run the app:

  ./godoc

godoc should come up at http://localhost:8080

Use the PORT environment variable to change the port:

    PORT=8081 ./godoc

Running locally, in production mode, using Docker
-------------------------------------------------

Build the app's Docker container:

  make docker-build

Make sure redis is running on port 6379:

  $ echo PING | nc localhost 6379
  +PONG
  ^C

Run the datastore emulator:

  gcloud beta emulators datastore start --project golang-org

In another terminal window, run the container:

  $(gcloud beta emulators datastore env-init)

  docker run --rm \
    --net host \
    --env GODOC_REDIS_ADDR=localhost:6379 \
    --env DATASTORE_EMULATOR_HOST=$DATASTORE_EMULATOR_HOST \
    --env DATASTORE_PROJECT_ID=$DATASTORE_PROJECT_ID \
    gcr.io/golang-org/godoc

godoc should come up at http://localhost:8080


Deploying to golang.org
-----------------------

Make sure you're signed in to gcloud:

  gcloud auth login

Build the image, push it to gcr.io, and deploy to Flex:

  make cloud-build deploy

Point the load balancer to the newly deployed version:
(This also runs regression tests)

  make publish

Stop and/or delete down any very old versions. (Stopped versions can be re-started.)
Keep at least one older verson to roll back to, just in case.
You can also migrate traffic to the new version via this UI.

  https://console.cloud.google.com/appengine/versions?project=golang-org&serviceId=default&versionssize=50


Troubleshooting
---------------

Ensure the Cloud SDK is on your PATH and you have the app-engine-go component
installed (gcloud components install app-engine-go) and your components are
up-to-date (gcloud components update)