Merge pull request #180 from myii/finalise-semantic-release
docs: merge latest changes from `template-formula`
This commit is contained in:
		
						commit
						39820094a9
					
				
							
								
								
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@ -108,3 +108,6 @@ Gemfile.lock
 | 
			
		||||
 | 
			
		||||
# copied `.md` files used for conversion to `.rst` using `m2r`
 | 
			
		||||
docs/*.md
 | 
			
		||||
 | 
			
		||||
# Vim
 | 
			
		||||
*.sw?
 | 
			
		||||
 | 
			
		||||
@ -26,9 +26,7 @@ services:
 | 
			
		||||
#       Ref: https://github.com/saltstack-formulas/template-formula/issues/121
 | 
			
		||||
env:
 | 
			
		||||
  matrix:
 | 
			
		||||
    # Disable tests on Salt develop for now
 | 
			
		||||
    # See: https://travis-ci.com/saltstack-formulas/php-formula/jobs/211316835
 | 
			
		||||
    # - INSTANCE: default-debian-9-develop-py3
 | 
			
		||||
    - INSTANCE: default-debian-9-develop-py3
 | 
			
		||||
    # - INSTANCE: default-ubuntu-1804-develop-py3
 | 
			
		||||
    # - INSTANCE: default-centos-7-develop-py3
 | 
			
		||||
    # - INSTANCE: default-fedora-29-develop-py3
 | 
			
		||||
 | 
			
		||||
@ -1,13 +0,0 @@
 | 
			
		||||
===========
 | 
			
		||||
php-formula
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
0.2.0
 | 
			
		||||
-----
 | 
			
		||||
 | 
			
		||||
- Added .ng states
 | 
			
		||||
 | 
			
		||||
0.1.0
 | 
			
		||||
-----
 | 
			
		||||
 | 
			
		||||
- Initial version
 | 
			
		||||
@ -725,6 +725,21 @@ Testing
 | 
			
		||||
 | 
			
		||||
Linux testing is done with ``kitchen-salt``.
 | 
			
		||||
 | 
			
		||||
Requirements
 | 
			
		||||
^^^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
* Ruby
 | 
			
		||||
* Docker
 | 
			
		||||
 | 
			
		||||
.. code-block:: bash
 | 
			
		||||
 | 
			
		||||
   $ gem install bundler
 | 
			
		||||
   $ bundle install
 | 
			
		||||
   $ bin/kitchen test [platform]
 | 
			
		||||
 | 
			
		||||
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
 | 
			
		||||
e.g. ``debian-9-2019-2-py3``.
 | 
			
		||||
 | 
			
		||||
``bin/kitchen converge``
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										15
									
								
								kitchen.yml
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								kitchen.yml
									
									
									
									
									
								
							@ -18,24 +18,36 @@ platforms:
 | 
			
		||||
      provision_command:
 | 
			
		||||
        - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
 | 
			
		||||
        - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
 | 
			
		||||
    provisioner:
 | 
			
		||||
      pillars_from_files:
 | 
			
		||||
        php.sls: test/salt/pillar/debian.sls
 | 
			
		||||
  - name: ubuntu-1804-develop-py3
 | 
			
		||||
    driver:
 | 
			
		||||
      image: netmanagers/salt-develop-py3:ubuntu-18.04
 | 
			
		||||
      provision_command:
 | 
			
		||||
        - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
 | 
			
		||||
        - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
 | 
			
		||||
    provisioner:
 | 
			
		||||
      pillars_from_files:
 | 
			
		||||
        php.sls: test/salt/pillar/debian.sls
 | 
			
		||||
  - name: centos-7-develop-py3
 | 
			
		||||
    driver:
 | 
			
		||||
      image: netmanagers/salt-develop-py3:centos-7
 | 
			
		||||
      provision_command:
 | 
			
		||||
        - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
 | 
			
		||||
        - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
 | 
			
		||||
    provisioner:
 | 
			
		||||
      pillars_from_files:
 | 
			
		||||
        php.sls: test/salt/pillar/redhat.sls
 | 
			
		||||
  - name: fedora-29-develop-py3
 | 
			
		||||
    driver:
 | 
			
		||||
      image: netmanagers/salt-develop-py3:fedora-29
 | 
			
		||||
      provision_command:
 | 
			
		||||
        - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
 | 
			
		||||
        - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
 | 
			
		||||
    provisioner:
 | 
			
		||||
      pillars_from_files:
 | 
			
		||||
        php.sls: test/salt/pillar/redhat.sls
 | 
			
		||||
  - name: opensuse-leap-15-develop-py3
 | 
			
		||||
    driver:
 | 
			
		||||
      image: netmanagers/salt-develop-py3:opensuse-leap-15
 | 
			
		||||
@ -43,6 +55,9 @@ platforms:
 | 
			
		||||
        - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
 | 
			
		||||
        - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
 | 
			
		||||
      run_command: /usr/lib/systemd/systemd
 | 
			
		||||
    provisioner:
 | 
			
		||||
      pillars_from_files:
 | 
			
		||||
        php.sls: test/salt/pillar/suse.sls
 | 
			
		||||
 | 
			
		||||
  ## SALT 2019.2
 | 
			
		||||
  - name: debian-9-2019-2-py3
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										50
									
								
								test/integration/default/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								test/integration/default/README.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,50 @@
 | 
			
		||||
# Default InSpec Profile
 | 
			
		||||
 | 
			
		||||
This shows the implementation of the Default InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md).
 | 
			
		||||
 | 
			
		||||
## Verify a profile
 | 
			
		||||
 | 
			
		||||
InSpec ships with built-in features to verify a profile structure.
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
$ inspec check default
 | 
			
		||||
Summary
 | 
			
		||||
-------
 | 
			
		||||
Location: default
 | 
			
		||||
Profile: profile
 | 
			
		||||
Controls: 4
 | 
			
		||||
Timestamp: 2019-06-24T23:09:01+00:00
 | 
			
		||||
Valid: true
 | 
			
		||||
 | 
			
		||||
Errors
 | 
			
		||||
------
 | 
			
		||||
 | 
			
		||||
Warnings
 | 
			
		||||
--------
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Execute a profile
 | 
			
		||||
 | 
			
		||||
To run all **supported** controls on a local machine use `inspec exec /path/to/profile`.
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
$ inspec exec default
 | 
			
		||||
..
 | 
			
		||||
 | 
			
		||||
Finished in 0.0025 seconds (files took 0.12449 seconds to load)
 | 
			
		||||
8 examples, 0 failures
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Execute a specific control from a profile
 | 
			
		||||
 | 
			
		||||
To run one control from the profile use `inspec exec /path/to/profile --controls name`.
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
$ inspec exec default --controls package
 | 
			
		||||
.
 | 
			
		||||
 | 
			
		||||
Finished in 0.0025 seconds (files took 0.12449 seconds to load)
 | 
			
		||||
1 examples, 0 failures
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
See an [example control here](https://github.com/inspec/inspec/blob/master/examples/profile/controls/example.rb).
 | 
			
		||||
@ -4,9 +4,9 @@ maintainer: Nicolas Rodriguez
 | 
			
		||||
license: Apache-2.0
 | 
			
		||||
summary: Verify that the php formula is setup and configured correctly
 | 
			
		||||
supports:
 | 
			
		||||
  - os-name: debian
 | 
			
		||||
  - os-name: ubuntu
 | 
			
		||||
  - os-name: centos
 | 
			
		||||
  - os-name: fedora
 | 
			
		||||
  - os-name: opensuse
 | 
			
		||||
  - os-name: suse
 | 
			
		||||
  - platform-name: debian
 | 
			
		||||
  - platform-name: ubuntu
 | 
			
		||||
  - platform-name: centos
 | 
			
		||||
  - platform-name: fedora
 | 
			
		||||
  - platform-name: opensuse
 | 
			
		||||
  - platform-name: suse
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user