Browse Source

update docs

tags/v1.4.28
Jonathan Cobb 4 years ago
parent
commit
187befa334
32 changed files with 10 additions and 69 deletions
  1. +0
    -1
      bin/bactivate
  2. +0
    -1
      bin/bconst
  3. +2
    -0
      bin/bdecrypt
  4. +0
    -1
      bin/bdelete
  5. +2
    -0
      bin/bencrypt
  6. +0
    -1
      bin/bget
  7. +0
    -1
      bin/bgeti
  8. +0
    -1
      bin/bgeti1
  9. +0
    -1
      bin/bgetn
  10. +0
    -1
      bin/bgetn1
  11. +0
    -1
      bin/bmodel
  12. +0
    -1
      bin/bpatch
  13. +0
    -1
      bin/bpatchfull
  14. +0
    -1
      bin/bpost
  15. +0
    -1
      bin/bposte
  16. +0
    -1
      bin/bput
  17. +0
    -1
      bin/bpute
  18. +0
    -1
      bin/bpyvenv.sh
  19. +0
    -1
      bin/bscript
  20. +0
    -1
      bin/bubble
  21. +2
    -0
      bin/bubble_common
  22. +0
    -1
      bin/bunlock
  23. +0
    -1
      bin/cleanup_bubble_databases
  24. +0
    -1
      bin/git_update_bubble.sh
  25. +4
    -0
      bin/install_packer.sh
  26. +0
    -1
      bin/jq-all-vals
  27. +0
    -1
      bin/list_bubble_databases
  28. +0
    -42
      bin/new_bubble.sh
  29. +0
    -1
      bin/prep_bubble_jar
  30. +0
    -1
      bin/reset_bubble_db
  31. +0
    -1
      bin/reset_bubble_full
  32. +0
    -1
      bin/reset_bubble_logs

+ 0
- 1
bin/bactivate View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Initial activation of a bubble server
#
# Usage: bactivate activation.json


+ 0
- 1
bin/bconst View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Write a constant value to stdout.
#
# This will only ever write the constant value to stdout if it can successfully be read.


+ 2
- 0
bin/bdecrypt View File

@@ -2,6 +2,8 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
# Decrypt data using the Bubble database's encryption key
#
SCRIPT="${0}"
SCRIPT_DIR=$(cd $(dirname ${SCRIPT}) && pwd)
. ${SCRIPT_DIR}/bubble_common


+ 0
- 1
bin/bdelete View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP DELETE against the API
#
# Usage:


+ 2
- 0
bin/bencrypt View File

@@ -2,6 +2,8 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
# Encrypt data using the Bubble database's encryption key
#
SCRIPT="${0}"
SCRIPT_DIR=$(cd $(dirname ${SCRIPT}) && pwd)
. ${SCRIPT_DIR}/bubble_common


+ 0
- 1
bin/bget View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP GET against the API
#
# Usage:


+ 0
- 1
bin/bgeti View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP GET against the API, then print out the "uuid" attribute only
#
# Usage:


+ 0
- 1
bin/bgeti1 View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP GET against the API, then print out the "uuid" attribute only, and only the first one
#
# Usage:


+ 0
- 1
bin/bgetn View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP GET against the API, then print out the "name" attribute only
#
# Usage:


+ 0
- 1
bin/bgetn1 View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP GET against the API, then print out the "name" attribute only, and only the first one
#
# Usage:


+ 0
- 1
bin/bmodel View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Write a model to a bubble server
#
# Usage: bmodel [-u/--update-all] model-file


+ 0
- 1
bin/bpatch View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Usage:
#
# bpatch [user@]hostname [norestart]


+ 0
- 1
bin/bpatchfull View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Usage:
#
# bpatchfull [user@]hostname [norestart]


+ 0
- 1
bin/bpost View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP POST against the API
#
# Usage:


+ 0
- 1
bin/bposte View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP POST against the API with an empty request entity
#
# Usage:


+ 0
- 1
bin/bput View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP PUT against the API
#
# Usage:


+ 0
- 1
bin/bpute View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run an HTTP PUT against the API with an empty request entity
#
# Usage:


+ 0
- 1
bin/bpyvenv.sh View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Set up python venv to run scripts in bin
#
function die {


+ 0
- 1
bin/bscript View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Run a local JSON API script against a remote API server
#
# Usage:


+ 0
- 1
bin/bubble View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Bubble client script. Wraps the run.sh script.
#
# Usually not called directly, instead use one of the higher-level wrappers: sync-model, run-script


+ 2
- 0
bin/bubble_common View File

@@ -2,6 +2,8 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
# Utility functions and standard pre-processing for many bubble CLI commands.
#
function die() {
if [[ -z "${SCRIPT}" ]]; then
echo 1>&2 "${1}"


+ 0
- 1
bin/bunlock View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Unlock a new bubble
#
# Usage:


+ 0
- 1
bin/cleanup_bubble_databases View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Drop the various temporary databases that sometimes get left around by the tests
# Do not run this command while tests are running
#


+ 0
- 1
bin/git_update_bubble.sh View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Update repository from master, including submodules, and rebuild bubble jar file
#
# Usage:


+ 4
- 0
bin/install_packer.sh View File

@@ -2,6 +2,10 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
# Installs Packer and the Packer Vultr plugin.
#
# It is safe to run this command multiple times, it is idempotent.
#
function die {
echo 1>&2 "${1}"
exit 1


+ 0
- 1
bin/jq-all-vals View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Print all values for a JSON property name, among any given JSON via stdin.
# JSON could be object, array, nested objects, etc.
#


+ 0
- 1
bin/list_bubble_databases View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# List bubble databases
#
# Usage:


+ 0
- 42
bin/new_bubble.sh View File

@@ -1,42 +0,0 @@
#!/bin/bash
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Launch a new bubble from a sage node
#
# Usage: new_bubble.sh config-file
#
# config-file : a JSON file with parameters to indicate how the bubble should be created
# see models/include/new_bubble.json for all parameters
#
# Minimally required JSON properties:
# sageFqdn : fully-qualified domain name (FQDN) of a bubble sage. This must be a valid sage node.
# network : network name of the bubble to create. This network must *not* already exist.
#
# For example:
# {
# "sageFqdn": "bubble-sage.example.com",
# "network": "mynetwork"
# }
#
# Environment variables
#
# BUBBLE_API : which API to use. Default is local (http://127.0.0.1:PORT, where PORT is found in .bubble.env)
# BUBBLE_USER : account to use. Default is root
# BUBBLE_PASS : password for account. Default is root
# BUBBLE_ENV : env file to load. Default is ~/.bubble.env or /home/bubble/api/bubble.env (whichever is found first)
# DEBUG_PORT : if set, this is the port number the client will wait for a debugger to attach before starting
# BUBBLE_INCLUDE : when using the sync-model and run-script commands, this is the directory to find included files
# For sync-model and migrate-model, the default is the current directory.
# For run-script, the default is a directory named "tests" within the current directory
# BUBBLE_SCRIPTS : location of run.sh script. Default is to assume it is in the same directory containing this script
#
SCRIPT="${0}"
SCRIPT_DIR=$(cd $(dirname ${SCRIPT}) && pwd)
. ${SCRIPT_DIR}/bubble_common

CONFIG_JSON="${1:?no config json provided}"
shift

cat ${CONFIG_JSON} | exec ${SCRIPT_DIR}/bscript ${SCRIPT_DIR}/../scripts/new_bubble.json ${@} --call-include --vars -

+ 0
- 1
bin/prep_bubble_jar View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Prepares the bubble.jar file for active usage.
#
# 1. Copy scripts to bubble-server/target/classes/scripts


+ 0
- 1
bin/reset_bubble_db View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Reset the local "bubble" database
#
# Usage: reset_bubble_db [debug]


+ 0
- 1
bin/reset_bubble_full View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Perform a full reset of Bubble. Removes the database and all locally stored files
#
# Usage: reset_bubble_full


+ 0
- 1
bin/reset_bubble_logs View File

@@ -2,7 +2,6 @@
#
# Copyright (c) 2020 Bubble, Inc. All rights reserved. For personal (non-commercial) use, see license: https://getbubblenow.com/bubble-license/
#
#
# Truncate all bubble logs
#
BUBBLE_LOGS_DIR=/var/log/bubble


Loading…
Cancel
Save