gocd / docs.go.cd Goto Github PK
View Code? Open in Web Editor NEWGoCD user documentation
Home Page: https://docs.gocd.org
License: Apache License 2.0
GoCD user documentation
Home Page: https://docs.gocd.org
License: Apache License 2.0
On a job level environment variable configuration:
The following works when using parameters passed from another pipleline to my template:
Environment Variables
Name Value
BRANCH #{PIPELINE_BRANCH}_INDEX
However, this does not.
Name Value
BRANCH ${STAGE_LEVEL_ENVIRONMENT_VARIABLE}_INDEX
in the latter case, it takes the literal value without replacing with the environment variable
In https://docs.gocd.org/18.3.0/gocd_on_kubernetes/gocd_helm_chart/configure_cluster.html#configure-service-account instructions are given for starting the cluster with kubeadm. If following the getting started from the beginning the cluster has already been started at https://docs.gocd.org/18.3.0/gocd_on_kubernetes/gocd_helm_chart/setup.html#2-setup-a-kubernetes-cluster
https://docs.gocd.org/current/configuration/tfs_config.html is outdated
Some of the outdated info that I could find:
Go server and agent uses TFS Java SDK v10
TFS 2011 support has not been verified.
Currently we document only 4 system properties for the user to configure - https://docs.gocd.org/current/advanced_usage/other_config_options.html
Summary
Documentation required for specifying agent server bind port ( defaults to 8152 ) but is configurable and this needs to be documented.
Basic environment details
Go Version: 17.11.0
JAVA Version: JAVA8
OS: NA
Browser vendor and version (if relevant):NA
Steps to Reproduce
Expected Results
User should have the information about the configurable port
Actual Results
Currently, the documentation is missing
Some GoCD documentation pages aren't responsive to browser widths between about 686px and 1430px. For example, this page about installing an agent on Linux is cut off on the right and there isn't a horizontal scrollbar - Chrome on Windows 10:
https://docs.gocd.org/current/installation/install/agent/linux.html
The following page shows that **GO_SERVER_SYSTEM_PROPERTIES**
should be set to -Dgo.plugin.upload.enabled=true
. This does not seem to work for me, but @varshavaradarajan provided the following value which does work: -Dgo.plugin.upload.enabled=Y
(thread). I'm using a gocd docker container and it might differ a bit from a standard install, but I doubt it.
This page https://github.com/gocd/docs.go.cd/blob/master/beta/plugin_upload.md should be updated to reflect the correct property value.
The upgrade documentation here should have an explicit note of upgrading addons with the corresponding GoCD server version.
It says:
After installing the GoCD agent, you must first configure the agent with the hostname (or IP address) of your GoCD server, in order to do this:
Open /usr/share/go-agent/wrapper-config/wrapper-properties.conf in your favourite text editor.
Follow the instructions in the file to configure the GoCD server url
The file has:
# setup the GoCD server URL
wrapper.app.parameter.100=-serverUrl
wrapper.app.parameter.101=http://localhost:8153/go
What is 100, 101? I think maybe it should be:
wrapper.app.parameter.101=http://gocd.localinternaldomain.com:8153/go
But this is only a guess. Maybe it is clear if you already know some java specific configuration syntax?
Update the screenshots here and other relevant places for User Management a.k.a User summary page
Hello,
I'm trying to install GoCD on Ubuntu using the APT repository following the instructions here
However, I'm getting the following error
sudo apt-get update
deb [signed-by=/etc/apt/keyrings/gocd.gpg] https://download.gocd.org /
Hit:1 https://dl.google.com/linux/chrome/deb stable InRelease
Get:2 https://download.gocd.org InRelease [2478 B]
Err:2 https://download.gocd.org InRelease
The following signatures couldn't be verified because the public key is not available: NO_PUBKEY D8843F288816C449
Hit:3 http://security.ubuntu.com/ubuntu jammy-security InRelease
Hit:4 http://in.archive.ubuntu.com/ubuntu jammy InRelease
Hit:5 http://in.archive.ubuntu.com/ubuntu jammy-updates InRelease
Hit:6 http://in.archive.ubuntu.com/ubuntu jammy-backports InRelease
Reading package lists... Done
W: GPG error: https://download.gocd.org InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY D8843F288816C449
E: The repository 'https://download.gocd.org InRelease' is not signed.
N: Updating from such a repository can't be done securely, and is therefore disabled by default.
N: See apt-secure(8) manpage for repository creation and user configuration details.
Link to GoCD Server installation instructions from https://docs.gocd.org/current/installation/ is incorrect and leaves 404 error.
404 Not Found
Code: NoSuchKey
Message: The specified key does not exist.
Key: current/installation/installation/installing_go_server.html
RequestId: 97C3C9BE24A91554
HostId: jtNesGtHcxODA+YzdX5DX+qsnM7oV0ghKNFTm571/a1heQucPikGbHzsoIKGL4TLRJMAh7gPgK8=
See the new page:
https://docs.gocd.org/current/gocd_on_kubernetes.html
vs. the old page:
https://docs.gocd.org/19.1.0/gocd_on_kubernetes.html
At least, the old page has a link to go to the next page. The new page just drops you into a nearly empty page.
The Pipelines as code section has this example code (and a similar block for JSON) which does not save on GoCD 17.8.0:
<config-repos>
<config-repo plugin="yaml.config.plugin">
<git url="https://github.com/tomzo/gocd-yaml-config-example.git" />
</config-repo>
</config-repos>
I updated the element to <config-repo plugin="yaml.config.plugin" id="myreponame">
and it worked, but it'd be great if this was present in the docs. Happy to submit a PR for this, but is there a preferred value for the id? Or just any unique string?
As a newcomer to GoCD, acting in a sysadmin/operations role, I was reading about how it implements its pipeline configuration from code. The official documentation kept showing, but not explaining why, a separate "configs only" git repository was being used for the "config" repo (that is, separate from the "material" repo). I was nearly completely turned off on GoCD by the usage of separate "config" repos appearing to be a hard requirement, as no other option was pointed out as possible.
The following enormous closed Github issue is the first place I ever saw it mentioned that using the material repository as the "config" repo was possible (or at least it is part of the detailed proposal..): gocd/gocd#1133
I think the documentation would benefit from spelling this out more clearly, perhaps indicating what the pros and cons of "config repo" vs. "config in material repo" are.
I'm not qualified on the topic for a PR submission.
The following pages/SPA have been modified but the screenshots used in the doc still shows the older ones. They should be updated.
Moved over from: gocd/gocd#2033
File which needs to be changed: https://github.com/gocd/docs.go.cd/blob/master/installation/install/agent/osx.md
Content (from gocd/gocd#2033, by @janfabry):
The Go Agent docs for Mac OS X mention logs in /var/log/system.log
, but useful logs are actually sent somewhere to the ~/Library/Application Support/Go Agent/*.log
files.
Running the Go agent and trying to debug connection problems.
Go Version: 16.2.1.3027
JAVA Version: 1.8.0_40
OS: Max OS X 11.1
Start the Go agent, check /var/log/system.log
for output.
Some output from the agent.
No output :-)
Useful logs are located in ~/Library/Application Support/Go Agent
in the following files:
osx-app.log
: the main log file of the appgo-agent-bootstrapper.log
go-agent-launcher.log
I would certainly mention the osx-app.log
file in the documentation.
Currently the only documentation about any kind of configuration uses the UI. I have not found any example where this was not the case.
Ideally I would wish for examples in terraform, but it would also be enough to know where the configuration is placed and what the format and schema of the file is. If this was treated a stable API, it would be even better.
I am running a go-agent. I want to run multiple agents from the same machine. Earlier I remember there was a documentation on how to do this on the main site. Now as per this file
docs.go.cd/content/advanced_usage/admin_install_multiple_agents.md
It is advised to look in /usr/share/go-agent/docs.
On my installation there is no docs folder. How do I find this?
Hi,
I installed a new agent on a server with the latest version available (19.4.0 Windows).
Installation was ok, but I did not achieve to see the new agent on my GoCD Server (19.1 Windows).
After some investigation, I saw this error in "go-agent-stderr" log file :
2019-06-04 11:26:36,658 - [Tue Jun 04 11:26:36 CEST 2019] Starting process:
2019-06-04 11:26:36,658 - [Tue Jun 04 11:26:36 CEST 2019] Working directory : D:\Program Files (x86)\Go Agent
2019-06-04 11:26:36,658 - [Tue Jun 04 11:26:36 CEST 2019] Application arguments: [-serverUrl, https://172.XXX.XXX.XX:8154/go, -sslVerificationMode, NONE]
2019-06-04 11:26:36,658 - [Tue Jun 04 11:26:36 CEST 2019] GoCD Version: 19.1.0-8469
2019-06-04 11:26:37,627 - Running GoCD requires Java version >= VERSION_1_8 and <= 11. You are currently running with Java version 12. GoCD will now exit!
I could see the openjdk version packaged with the agent is 12.0X. I checked on my previous installation agent 19.2, i got a openjdk version 11.
Either the agent source code is incorrect and it should let the use of java 12, or the jdk packaged should be changed to java 11.
We need add some new user document for a new git material option. (gocd/gocd#1997).
@juhijariwala, I over heard you are splitting two document repos, and wondering is this a good send PR for this repo?
-- wpc
See: https://docs.gocd.org/current/faq/environment_variables.html
Works in Chrome.
The plugin will be re-downloaded whenever the goserver pod is restarted,
Can't add a test in install script? When the plugin exists, it will not be downloaded again
"While upgrading GoCD agents is not necessary (agents will usually auto-upgrade if they detect a new version deployed on the server). Going forward, we will ensure that agents are backward compatible with atleast 1"
Probably you want to finish the sentence :)
The old docs.go.cd used to show a link icon for each subsection on hover. Clicking on this would provide the provide the link to the subsection in the url. It would be nice to have that for the new docs.
See #286. I'd have expected our link checker task to ensure this should not have happened.
https://docs.gocd.org/current/gocd_on_kubernetes/docker_workflows.html in this page it is mentioned that.
Add a note about environment variables such as GO_REVISION, GO_DEPENDENCY_LABEL etc that go sets by default, which could be used in the tasks.
It's not clear in the docs that the GO_DEPENDENCY_LABEL_ suffix should be the upstream pipeline's "Material Name". This name should be converted to uppercase with hyphens converted to underscores.
Eg:
The Pipeline Label for an Upstream Pipeline with "Material Name" = "upstream_services-frontend"
Would be available as the environment variable:
${GO_DEPENDENCY_LABEL_UPSTREAM_SERVICES_FRONTEND}
Some of the pages are duplicated in the repository. This is to support backward compatibility of few links.
Examples:
Problems with maintaining multiple branches:
Proposed change:
Maintain directories for different versions in master
itself, using the same gitbook version. Build scripts and pipelines would need to be changed accordingly.
Thoughts, suggestions, comments are welcome.
As stated in topic. Following the getting started doc, the deployment at the end fails, but the script doesn't catch the failure.
minikube version: v0.25.0
Darwin KM-MBP-15.local 17.4.0 Darwin Kernel Version 17.4.0: Sun Dec 17 09:19:54 PST 2017; root:xnu-4570.41.2~1/RELEASE_X86_64 x86_64
kubectl version
Client Version: version.Info{Major:"1", Minor:"9", GitVersion:"v1.9.2", GitCommit:"5fa2db2bd46ac79e5e00a4e6ed24191080aa463b", GitTreeState:"clean", BuildDate:"2018-01-18T10:09:24Z", GoVersion:"go1.9.2", Compiler:"gc", Platform:"darwin/amd64"}
Server Version: version.Info{Major:"1", Minor:"9", GitVersion:"v1.9.0", GitCommit:"925c127ec6b946659ad0fd596fa959be43f0cc05", GitTreeState:"clean", BuildDate:"2017-12-15T20:55:30Z", GoVersion:"go1.9.2", Compiler:"gc", Platform:"linux/amd64"}
[go] Task: ./app-deployment.shtook: 0.450s
Namespace gocd
Creating deployment
{
"kind": "Status",
"apiVersion": "v1",
"metadata": {
},
"status": "Failure",
"message": "the API version in the data (apps/v1beta2) does not match the expected API version (apps/v1)",
"reason": "BadRequest",
"code": 400
}
This is a placeholder for the documentation update to add notes on how to add private Github repositories to Go in the FAQ section.
Hey guys
on this page https://docs.gocd.org/current/installation/configure-agent-proxy.html are 2 typos.
wrapper.java.additional.101-Dhttps.proxyPort=3128 ## WRONG
wrapper.java.additional.101=-Dhttps.proxyPort=3128 ## RIGHT
wrapper.java.additional.102-Dhttp.nonProxyHosts=localhost|.department.acme.com ## WRONG
wrapper.java.additional.102=-Dhttp.nonProxyHosts=localhost|.department.acme.com ## RIGHT
Invest 30 minutes of debug to find the issue there /o.
Maybe it's possible to fix it :)
Greets
Andreas
I followed the web instructions to download and install server and agent 21.2.0 on Linux. It seems to work fine. I'd like to make some global configuration adjustments to the jobs that are run. The docs suggest that configuration can be done in /etc/default/go-agent
. In fact, https://cvjt.gitbooks.io/gocd-official-manual/content/installation/install/agent/linux.html suggests that I should configure GO_SERVER_URL
in there.
But it doesn't exist.
Up-to-date Ubuntu Linux 21.04.
The pod config in the tutorial https://docs.gocd.org/current/gocd_on_kubernetes/importing_a_sample_workflow.html
references an image gocddemo/gocd-agent-dind:webinar
which uses GoCD Version: 18.3.0-6540
kind: Pod
metadata:
name: pod-name-prefix-{{ POD_POSTFIX }}
labels:
app: web
spec:
containers:
- name: gocd-agent-container-{{ CONTAINER_POSTFIX }}
image: gocddemo/gocd-agent-dind:webinar
...
v18.3.0-6540
has the https serverUrl requirement which causes the helm deployed gocd app to fail
bash-4.4# java -jar agent-bootstrapper.jar -help
[Wed May 05 02:35:20 GMT 2021] Starting process:
[Wed May 05 02:35:20 GMT 2021] Working directory : /go-agent
[Wed May 05 02:35:20 GMT 2021] Application arguments: [-help]
[Wed May 05 02:35:20 GMT 2021] GoCD Version: 18.3.0-6540
...
Options:
-help
Print this help
-rootCertFile
The root certificate from the certificate chain of the GoCD server (in
PEM format)
* -serverUrl
The GoCD server URL. Must begin with `https://`, and end with `/go`
-sslVerificationMode
The SSL verification mode.
Default: NONE
Possible Values: [FULL, NONE, NO_VERIFY_HOST]
Latest version does not have that requirement v21.2.0
bash-5.1$ /gocd-jre/bin/java -jar agent-bootstrapper.jar -help
[Wed May 05 02:36:20 GMT 2021] Starting process:
[Wed May 05 02:36:20 GMT 2021] Working directory : /go-agent/lib
[Wed May 05 02:36:20 GMT 2021] Application arguments: [-help]
[Wed May 05 02:36:20 GMT 2021] GoCD Version: 21.2.0-12498
[Wed May 05 02:36:20 GMT 2021] Java Version: 15.0.2
[Wed May 05 02:36:20 GMT 2021] Operating System: Linux(5.10.25-linuxkit)
Usage: java -jar agent-bootstrapper.jar [options]
Options:
-help
Print this help
-rootCertFile
The root certificate from the certificate chain of the GoCD server (in
PEM format)
* -serverUrl
The GoCD server URL. Example: http://gocd.example.com:8153/go
-sslCertificateFile
The X509 certificate for mutual TLS.
-sslPrivateKeyFile
The private key for mutual TLS.
-sslPrivateKeyPassphraseFile
The file containing the passphrase for decoding the SSL private key.
-sslVerificationMode
The SSL verification mode.
Default: FULL
Possible Values: [FULL, NONE, NO_VERIFY_HOST]
Docker Desktop for Mac
Hello world example should work
Hello world example didn't work.
Update docs to point to more recent agent pod template. Maybe gocd/gocd-agent-docker-dind:v21.2.0
?
I have just spent hours to figure out how to change the go-server
's port. (Environment: Linux)
The official doc here does not provide enough information.
Workaround:
Adding wrapper.java.additional.{}
property to /usr/share/go-server/wrapper-config/wrapper.conf
For example,
wrapper.java.additional.12=-Dcruise.server.port=28153
Browser: Google Chrome Version 76.0.3809.100 (Official Build) (64-bit)
OS: MacOS 10.14.6
Steps to reproduce:
Open a link to the documentation containing a fragment, such as this in Chrome
Expected: The page should scroll to Step 2: Material
Actual: The page doesn't scroll to the right section, stays on top of the page
(Works as expected on Firefox)
I'm reading through the documentation of GoCD installation on Linux: https://docs.gocd.org/current/installation/install/server/linux.html#copying-existing-config-to-a-new-gocd-server-instance
It nicely enumerates a set of configuration files, which does not include cruise-config.xml
: https://docs.gocd.org/current/installation/install/server/linux.html#location-of-gocd-server-files.
Then in the next paragraph, cruise-config.xml
suddenly comes up out of nowhere, and it's never mentioned, where it is located: https://docs.gocd.org/current/installation/install/server/linux.html#copying-existing-config-to-a-new-gocd-server-instance.
Please, improve your (otherwise very beautiful and user-friendly) documentation.
Thank you!
Add warning to indicate the password storage in password file is not secured compared to other authentication method
There appears to be no consolidated guide/howto for use of the SCM notification webhooks. While they are included in the API docs these aren't really traditional API and seem they should be documented in the main documentation.
Suggested content
config_repos
webhooks added in 21.1.0
in #8023 seem to not be documented at all; this documentation should probably include mention of that, or build on top of gocd/api.go.cd#1037A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.