Skip to content

Commit

Permalink
Basic reformatting
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Dec 4, 2023
1 parent a3c1709 commit c674514
Show file tree
Hide file tree
Showing 15 changed files with 77 additions and 77 deletions.
12 changes: 6 additions & 6 deletions content/api_omnitruck.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Chef Software products and to provide direct download URLs.

The URL from which these downloads can be obtained has the following syntax:

```none
```plain
https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest&prerelease=false&nightlies=false
```

or:

```none
```plain
https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest&prerelease=false&nightlies=false
```

Expand All @@ -40,13 +40,13 @@ single step.

The `/metadata` and/or `/download` endpoints can be used to download packages for all products:

```none
```plain
https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest
```

or:

```none
```plain
https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest
```

Expand Down Expand Up @@ -164,13 +164,13 @@ This is a list of currently supported products that you can install with the Omn

To get the latest supported build for Ubuntu 20.04, enter the following:

```none
```plain
https://omnitruck.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64
```

to return something like:

```none
```plain
sha1 3fe8e8a2f443675f9b82e876cdac8200104451f2
sha256 9f1c1a2c0b1f4e8494664386437bf32f0cb5cbfbd4cb9d23e327767fc65581dc
url https://packages.chef.io/files/stable/chef/17.7.29/ubuntu/20.04/chef_17.7.29-1_amd64.deb
Expand Down
2 changes: 1 addition & 1 deletion content/cookbook_versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ knife cookbook upload redis --force
Without the `--force` option specified, an error will be returned
similar to:

```none
```bash
Version 0.0.0 of cookbook redis is frozen. Use --force to override
```

Expand Down
2 changes: 1 addition & 1 deletion content/ctl_chef_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ threads. To increase the system process limits:
When the system process limits are too low, an error is returned similar
to:

```none
```bash
Error Syncing Cookbooks:
==================================================================
Expand Down
6 changes: 3 additions & 3 deletions content/data_bags.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ knife data bag from file BAG_NAME ITEM_NAME.json

will load the following file:

```none
```plain
data_bags/BAG_NAME/ITEM_NAME.json
```

Expand Down Expand Up @@ -255,7 +255,7 @@ knife data bag show passwords mysql
where "passwords" is the name of the data bag and "mysql" is the name of
the data bag item. This will return something similar to:

```none
```bash
id: mysql
pass:
cipher: aes-256-cbc
Expand Down Expand Up @@ -319,7 +319,7 @@ items for each environment.
A data bag that is storing a top-level key for an environment might look
something like this:

```none
```json
{
"id": "some_data_bag_item",
"production" : {
Expand Down
2 changes: 1 addition & 1 deletion content/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ override[:test][:source] = 'attributes override'

To debug the location in which the value of `node[:test][:source]` is set, use chef-shell and run a command similar to:

```none
```ruby
pp node.debug_value('test', 'source')
```

Expand Down
2 changes: 1 addition & 1 deletion content/deprecations_chef_platform_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ library-based resources and providers that do not declare provides in
which case your Chef Infra Client run is likely full of a compilation of
warnings and deprecations:

```none
```plain
* foo[it] action doit[2016-12-07T14:28:59-08:00] WARN: Class Chef::Provider::Foo does not declare 'provides :foo'.
[2016-12-07T14:28:59-08:00] WARN: This will no longer work in Chef Infra Client 13: you must use 'provides' to use the resource's DSL.
(up to date)
Expand Down
90 changes: 45 additions & 45 deletions content/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,16 @@ Response: Failed to authenticate as USERNAME. Ensure that your node_name and cl

### Troubleshooting Steps

* Verify you have the correct values in your config.rb file, especially for the `node_name` and `client_key` settings.
- Verify you have the correct values in your config.rb file, especially for the `node_name` and `client_key` settings.

* Check if the file referenced in the `client_key` setting (usually USER.pem) exists. Some common locations include:
- Check if the file referenced in the `client_key` setting (usually USER.pem) exists. Some common locations include:
* `~/.chef`
* `~/projects/current_project/.chef`
* `/etc/chef`

If one is present, verify that it has the correct read permissions.

* If there's no client.rb file, regenerate it and ensure the values for the `node_name` and `client_key` settings are correct.
- If there's no client.rb file, regenerate it and ensure the values for the `node_name` and `client_key` settings are correct.

### Organization not found

Expand Down Expand Up @@ -196,8 +196,8 @@ To fix object permissions:
HTTP 500 is a non-specific error message. The full error message for the error Chef Infra Client is receiving can be found in one of the following log files:
* `/var/log/opscode/opscode-account/current`
* `/var/log/opscode/opscode-erchef/current`
- `/var/log/opscode/opscode-account/current`
- `/var/log/opscode/opscode-erchef/current`
The error will likely found in a stacktrace from the application error. In some cases the error message will clearly indicate a problem with another service which can be investigated further. For non-obvious errors, please contact Chef and attach the log files.
Expand Down Expand Up @@ -290,7 +290,7 @@ Work around this issue by supplying the full path to the client.rb file:
chef-client -c /etc/chef/client.rb
```
### Pivotal.rb does not exist
### Pivotal.rb doesn't exist
If you're seeing an error like:
Expand All @@ -302,9 +302,9 @@ ERROR: CONFIGURATION ERROR:Specified config file /etc/opscode/pivotal.rb does no
Run the following to restart all of the services:
> ```bash
> chef-server-ctl reconfigure
> ```
```bash
chef-server-ctl reconfigure
```
Because the Chef Infra Server is composed of many different services that work together to create a functioning system, this step may take a few minutes to complete.
Expand All @@ -320,7 +320,7 @@ The value of `postgresql['external']` has been changed.
#### Possible Causes
* This setting must be set before running
- This setting must be set before running
`chef-server-ctl reconfigure`, and may not be changed after
{{< warning >}}
Expand All @@ -331,8 +331,8 @@ Upgrading is not supported at this time.
#### Resolution
* Back up the data using `knife ec backup`, create a new backend instance, and then restore the data
* Re-point front end machines at the new backend instance **or** assign the new backend instance the name/VIP of the old backend instance (including certificates, keys, and so on)
- Back up the data using `knife ec backup`, create a new backend instance, and then restore the data
- Re-point front end machines at the new backend instance **or** assign the new backend instance the name/VIP of the old backend instance (including certificates, keys, and so on)
### CSPG010 (cannot connect)
Expand All @@ -342,10 +342,10 @@ Cannot connect to PostgreSQL on the remote server.
#### Possible Causes
* PostgreSQL is not running on the remote server
* The port used by PostgreSQL is blocked by a firewall on the remote server
* Network routing configuration is preventing access to the host
* When using Amazon Web Services (AWS), rules for security groups are preventing the Chef Infra Server from communicating with PostgreSQL
- PostgreSQL is not running on the remote server
- The port used by PostgreSQL is blocked by a firewall on the remote server
- Network routing configuration is preventing access to the host
- When using Amazon Web Services (AWS), rules for security groups are preventing the Chef Infra Server from communicating with PostgreSQL
### CSPG011 (cannot authenticate)
Expand All @@ -355,8 +355,8 @@ Cannot authenticate to PostgreSQL on the remote server.
#### Possible Causes
* Incorrect password specified for `db_superuser_password`
* Incorrect user name specified for `db_superuser`
- Incorrect password specified for `db_superuser_password`
- Incorrect user name specified for `db_superuser`
### CSPG012 (incorrect rules)
Expand All @@ -367,16 +367,16 @@ Cannot connect to PostgreSQL on the remote server because rules in
#### Possible Causes
* There is no `pg_hba.conf` rule for the `db_superuser` in PostgreSQL
* A rule exists for the `db_superuser` in `pg_hba.conf`, but it does not specify `md5` access
* A rule in `pg_hba.conf` specifies an incorrect originating address
- There is no `pg_hba.conf` rule for the `db_superuser` in PostgreSQL
- A rule exists for the `db_superuser` in `pg_hba.conf`, but it does not specify `md5` access
- A rule in `pg_hba.conf` specifies an incorrect originating address
#### Resolution
Entries in the `pg_hba.conf` file should allow:
* All user names that originate from any Chef Infra Server instance using `md5` authentication.
* A specific application names: `$db_superuser` (the configured superuser name in the chef-server.rb file), `oc_id`, `oc_id_ro`, `opscode_chef`, `opscode_chef_ro`, `bifrost`, and `bifrost_ro`
- All user names that originate from any Chef Infra Server instance using `md5` authentication.
- A specific application names: `$db_superuser` (the configured superuser name in the chef-server.rb file), `oc_id`, `oc_id_ro`, `opscode_chef`, `opscode_chef_ro`, `bifrost`, and `bifrost_ro`
##### pg_hba.conf User Names
Expand Down Expand Up @@ -430,13 +430,13 @@ SELECT pg_reload_conf();
Rules in the `pg_hba.conf` file should allow only specific application names:
* `$db_superuser` (the configured superuser name in the chef-server.rb file)
* `oc_id`
* `oc_id_ro`
* `opscode_chef`
* `opscode_chef_ro`
* `bifrost`
* `bifrost_ro`
- `$db_superuser` (the configured superuser name in the chef-server.rb file)
- `oc_id`
- `oc_id_ro`
- `opscode_chef`
- `opscode_chef_ro`
- `bifrost`
- `bifrost_ro`
### CSPG013 (incorrect permissions)
Expand All @@ -446,9 +446,9 @@ The `db_superuser` account has incorrect permissions.
#### Possible Causes
* The `db_superuser` account has not been granted `SUPERUSER` access
- The `db_superuser` account has not been granted `SUPERUSER` access
* The `db_superuser` account has not been granted `CREATE DATABASE` and `CREATE ROLE` privileges
- The `db_superuser` account has not been granted `CREATE DATABASE` and `CREATE ROLE` privileges
```bash
ALTER ROLE "$your_db_superuser_name" WITH SUPERUSER
Expand All @@ -468,7 +468,7 @@ Bad version of PostgreSQL.
#### Possible Causes
* The remote server is not running PostgreSQL version 9.2.x
- The remote server is not running PostgreSQL version 9.2.x
### CSPG015 (missing database)
Expand All @@ -478,12 +478,12 @@ The database template `template1` does not exist.
#### Possible Causes
* The `template1` database template has been removed from the remote
- The `template1` database template has been removed from the remote
server
#### Resolution
* Run the following command (as a superuser):
- Run the following command (as a superuser):
```bash
CREATE DATABASE template1 TEMPLATE template0
Expand All @@ -503,13 +503,13 @@ One (or more) of the PostgreSQL databases already exists.
#### Possible Causes
* The `opscode_chef`, `oc_id`, and/or `bifrost` databases already exist on the remote machine
* The PostgreSQL database exists for another application
- The `opscode_chef`, `oc_id`, and/or `bifrost` databases already exist on the remote machine
- The PostgreSQL database exists for another application
#### Resolution
* Verify that the `opscode_chef`, `oc_id`, and/or `bifrost` databases exist, and then verify that they are not being used by another internal application
* Back up the PostgreSQL data, remove the existing databases, and reconfigure the Chef server
- Verify that the `opscode_chef`, `oc_id`, and/or `bifrost` databases exist, and then verify that they are not being used by another internal application
- Back up the PostgreSQL data, remove the existing databases, and reconfigure the Chef server
### CSPG017 (user exists)
Expand All @@ -519,23 +519,23 @@ One (or more) of the PostgreSQL predefined users already exists.
#### Possible Causes
* The `opscode_chef`, `ospcode_chef_ro`, `bifrost`, `bifrost_ro`, `oc_id`, or `oc_id_ro` users already exist on the remote machine
* The `postgresql['vip']` setting is configured to a remote host, but `postgresql['external']` is not set to `true`, which causes the `opscode_chef` and `ospcode_chef_ro` users to be created before the machine is reconfigured, which will return a permissions error
* Existing, valid naming conflicts are present, where the users were created independently of the Chef server
- The `opscode_chef`, `ospcode_chef_ro`, `bifrost`, `bifrost_ro`, `oc_id`, or `oc_id_ro` users already exist on the remote machine
- The `postgresql['vip']` setting is configured to a remote host, but `postgresql['external']` is not set to `true`, which causes the `opscode_chef` and `ospcode_chef_ro` users to be created before the machine is reconfigured, which will return a permissions error
- Existing, valid naming conflicts are present, where the users were created independently of the Chef server
#### Resolution
* Run the following, if it is safe to do so, to update the user name that is specified in the error message:
- Run the following, if it is safe to do so, to update the user name that's specified in the error message:
```bash
DROP ROLE "name-of-user";
```
or change the name of the user by updating following settings in the chef-server.rb configuration file:
```none
```ruby
oc_id['sql_user'] = 'alternative_username'
oc_id['sql_ro_user'] = alternative_username_for_ro_access'
oc_id['sql_ro_user'] = 'alternative_username_for_ro_access'
opscode_erchef['sql_user'] = 'alternative_username'
opscode_erchef['sql_ro_user'] = 'alternative_username_for_ro_access'
oc_bifrost['sql_ro_user'] = 'alternative_username'
Expand Down
2 changes: 1 addition & 1 deletion content/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ cookbook in which the recipe is located is available to the system on
which chef-solo is running. For example, a file named `dna.json`
contains the following details:

```none
```json
{
"run_list": ["recipe[apache2]"]
}
Expand Down
Loading

0 comments on commit c674514

Please sign in to comment.