You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_ecosystem_8x/devkit/migrating.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,18 +16,22 @@ If you get an error about a command not being available, you probably just need
16
16
17
17
{% include alert.html type="tip" content="There are a few exceptions to this pattern. For example, Jig is an installed package and VoxBox is a Docker container." %}
18
18
19
-
| You used to type... | Now you type... |
20
-
|---------------------|------------------|
21
-
|`pdk new module`|`jig new module`|
22
-
|`pdk new class`|`jig new class`|
23
-
|`pdk build`|`jig build`|
24
-
|`pdk release`|`jig release`|
25
-
|`pdk convert`|_not needed_|
26
-
|`pdk update`|`jig update`|
27
-
|`pdk validate`|`jig validate`|
28
-
|`pdk test unit`|`jig test unit`|
29
-
30
-
`jig update`, `jig validate`, and `jig test unit` are thin wrappers around `bundle exec msync update`, `bundle exec rake validate lint`, and `bundle exec rake spec` respectively, so they still need the module's gems installed (`bundle install`).
31
-
You can keep running the underlying `bundle exec` commands directly if you prefer.
19
+
Jig also contains thin wrappers around the `bundle exec` commands, so in many cases you can use the CLI patterns you're used to typing.
20
+
Because Jig does not attempt to hide the Bundler environment from you, it will still need the module's gems installed (`bundle install`) and ModuleSync configured properly.
21
+
22
+
{% include alert.html type="tip" title="Choosing command forms" content="If you want quick and familiar commands to run locally, then use the Jig wrapper commands. If you're running tests and such in CI or if you need to pass custom options then invoke the tools directly." %}
23
+
24
+
| You used to type... | Now you type... | Or run tools directly... |
|`pdk test unit`|`jig test unit`|`bundle exec rake spec`|
34
+
35
+
{% include alert.html type="note" title="*NOTE" content="`pdk update` operates in context of a single module. In contrast, the replacement ModuleSync commands (`jig update` and `bundle exec msync update`) should be run in the template repository to push updates to all your modules at once. [Read more](modulesync.html)." %}
32
36
33
37
Browse through the individual subpages of this Developer Tooling section to learn more about each component.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/config_important_settings.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ These settings should usually go in `[server]`. However, if you're using Puppet
125
125
### Basics
126
126
127
127
*[`dns_alt_names`][dns_alt_names] --- A list of hostnames the server is allowed to use when acting as an OpenVox Server. The hostname your agents use in their `server` setting **must** be included in either this setting or the master's `certname` setting. Note that this setting is only used when initially generating the OpenVox Server's certificate --- if you need to change the DNS names, you must:
128
-
1. Turn off the Puppet server service (or your Rack server).
128
+
1. Turn off the Puppet server service.
129
129
2. Run `sudo puppetserver ca clean --certname <SERVER'S CERTNAME>`.
130
130
3. Run `sudo puppetserver ca generate --certname <SERVER'S CERTNAME> --subject-alt-names <ALT NAME 1>,<ALT NAME 2>,...`.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/config_print.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ To see the settings the OpenVox Server service would use:
78
78
* Specify `--section server`.
79
79
* Use the `--environment` option to specify the environment you want settings for, or let it default to `production`.
80
80
* Remember to use `sudo`.
81
-
* If your OpenVox Server is managed as a rack application (e.g. with Passenger), check the `config.ru` file to make sure it's using the [confdir][]and[vardir][] that you expect. If it's using non-standard ones, you will need to specify them on the command line with the `--confdir` and `--vardir` options; otherwise you might not see the correct values for settings.
81
+
* If your OpenVox Server uses a non-standard [confdir][]or[vardir][], specify them on the command line with the `--confdir` and `--vardir` options; otherwise you might not see the correct values for settings.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/dirs_codedir.markdown
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,6 @@ When Puppet is running as either root, a Windows user with administrator privile
20
20
21
21
The system codedir is what you usually want to use, since you will usually run Puppet's commands and services as root or `puppet`. (Note that admin commands like `puppet module` must be run with `sudo` to use the same codedir as OpenVox agent or OpenVox Server.)
22
22
23
-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--codedir` to the system codedir. The example `config.ru` file provided with the Puppet source does this.
24
-
25
23
### Configuration
26
24
27
25
The location of the codedir can be configured in puppet.conf with [the `codedir` setting][codedir], but note that Puppet Server doesn't use that setting; it has its own `jruby-puppet.master-code-dir` setting [in puppetserver.conf][puppetserver_conf]. If you're using a non-default codedir, _you must change both settings._
Copy file name to clipboardExpand all lines: docs/_openvox_8x/dirs_confdir.markdown
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,6 @@ The system confdir is what you usually want to use, since you will usually run P
21
21
services as root or `puppet`. (Note that admin commands like `puppetserver ca` must be run with `sudo`
22
22
to use the same confdir as OpenVox agent or OpenVox Server.)
23
23
24
-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--confdir` to the system confdir. The example `config.ru` file provided with the Puppet source does this.
25
-
26
24
### Configuration
27
25
28
26
Puppet's confdir can be specified on the command line with the `--confdir` option, but it can't be set
Copy file name to clipboardExpand all lines: docs/_openvox_8x/dirs_vardir.markdown
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,8 +24,6 @@ The system cache directory is what you usually want to use, since you will usual
24
24
and services as root or `puppet`. (Note that admin commands like `puppetserver ca` must be run with
25
25
`sudo` to use the same directories as OpenVox agent or OpenVox Server.)
26
26
27
-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--vardir` to the system cache directory. The example `config.ru` file provided with the Puppet source does this.
28
-
29
27
### Configuring the location of the cache directory
30
28
31
29
You can specify Puppet's cache directory on the command line by using the `--vardir` option, but you can't set it in `puppet.conf`. If `--vardir` isn't specified when a Puppet application is started, it will always use the default cache directory location.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/static_catalogs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,7 @@ The script's standard output becomes the file's `code_content`, provided the scr
117
117
Starting in Puppet 4.4 and OpenVox Server 2.3.0, the global `static_catalogs` setting is enabled by default, whether you upgrade Puppet or perform a clean installation.
118
118
However, the default configuration doesn't include the `code-id-command` and `code-content-command` scripts or settings needed to produce static catalogs, and even when configured to produce static catalogs OpenVox Server doesn't inline metadata for all types of file resources.
119
119
120
-
Static catalogs are produced only by OpenVox Server. The Ruby OpenVox server never produces static catalogs, even when served by WEBrick or Passenger.
120
+
Static catalogs are produced only by OpenVox Server.
121
121
122
122
OpenVox Server also won't produce static catalogs for an agent under the following circumstances:
0 commit comments