You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by kemitix <gi...@git.apache.org> on 2018/08/24 15:02:22 UTC
[GitHub] brooklyn-docs pull request #266: Clean up docs
GitHub user kemitix opened a pull request:
https://github.com/apache/brooklyn-docs/pull/266
Clean up docs
* fix a few typos
* extract some code blocks to `example_yaml`
* fix loading bash script as tar.gz from url to ensure it is executable
* fix hi netcat example to close the connection at end of file
* wrap jdbc string format in quotes
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/kemitix/brooklyn-docs review-docs-for-530-rc3
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/brooklyn-docs/pull/266.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #266
----
commit d66451f2c534f7964f8aac1d5cfa149adbe61487
Author: Paul Campbell <pa...@...>
Date: 2018-08-22T13:57:38Z
example_yaml: make start.sh executable after extracting
/tmp/brooklyn-...-launching_VanillaSoftwareProce.sh:
line 9: ./start.sh: Permission denied
commit 767a7160e1a032f56034fd19766f24a7e90617a2
Author: Paul Campbell <pa...@...>
Date: 2018-08-22T14:32:10Z
example_yaml: netcat client closes connection after EOF
From the nc(1) man page:
-N shutdown(2) the network socket after EOF on the input. Some servers
require this to finish their work.
Ubuntu would appear to be one such server.
commit c0aaf80f12e0c284c804eb618805221dc5d03d13
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T11:50:16Z
Update to use datastore.creation.script.template.url
commit e8274fddc603dadbba6cf7933d76eb6a0bfcdd4c
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T11:51:56Z
Fix typo in example yaml for dynamicfabric
commit 845339d8cd4398aaa0f8463c52a1835071899c03
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T11:55:59Z
Quote jdbc string format templates
Ampersand (&) in format wasn't being parsed properly.
commit 46fc3814dcb634ebd34afd298554feae33c15309
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T12:59:40Z
Extract Entity Config example to YAML file
Added a name for the deployed application.
commit 37d84333e40041c16efa64d14b47aac14eb0e071
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T13:30:58Z
Extract Entity Constraint example to YAML file
commit ca1cd3f6f52d752ec5cdf92af714050d14d8e4a0
Author: Paul Campbell <pa...@...>
Date: 2018-08-24T14:53:45Z
Extract Entity Config Override example to YAML file
----
---
[GitHub] brooklyn-docs pull request #266: Clean up docs
Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on a diff in the pull request:
https://github.com/apache/brooklyn-docs/pull/266#discussion_r213967673
--- Diff: guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml ---
@@ -66,7 +66,7 @@ services:
name: sayHiNetcat
description: Echo a small hello string to the netcat entity
command: |
- echo $message | nc $TARGET_HOSTNAME 4321
+ echo $message | nc -N $TARGET_HOSTNAME 4321
--- End diff --
Yeah, or just add a note at the bottom to say that for MacOS, you need to remove `-N` 👍
---
[GitHub] brooklyn-docs pull request #266: Clean up docs
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/brooklyn-docs/pull/266
---
[GitHub] brooklyn-docs pull request #266: Clean up docs
Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on a diff in the pull request:
https://github.com/apache/brooklyn-docs/pull/266#discussion_r213939941
--- Diff: guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml ---
@@ -66,7 +66,7 @@ services:
name: sayHiNetcat
description: Echo a small hello string to the netcat entity
command: |
- echo $message | nc $TARGET_HOSTNAME 4321
+ echo $message | nc -N $TARGET_HOSTNAME 4321
--- End diff --
What the `-N` does? Also, I'm not sure this is advisable as some platform, i.e. MacOS don't have this option available
---
[GitHub] brooklyn-docs pull request #266: Clean up docs
Posted by kemitix <gi...@git.apache.org>.
Github user kemitix commented on a diff in the pull request:
https://github.com/apache/brooklyn-docs/pull/266#discussion_r213965368
--- Diff: guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml ---
@@ -66,7 +66,7 @@ services:
name: sayHiNetcat
description: Echo a small hello string to the netcat entity
command: |
- echo $message | nc $TARGET_HOSTNAME 4321
+ echo $message | nc -N $TARGET_HOSTNAME 4321
--- End diff --
Struggling to find how you would install an updated version of netcat on MacOS that would support this command. The problem is that on some platforms the `nc` command doesn't close the channel when `echo` terminates, which prevents the pipeline command from terminating.
Would a suitable solution be to include both options with one of them commented out and a comments saying `# MacOS` and `# Linux`?
e.g.
```yaml
# Uncomment the appropriate command for your operating system
# Linux
# echo $message | nc -N $TARGET_HOSTNAME 4321
# MacOS
# echo $message | nc $TARGET_HOSTNAME 4321
```
---