diff --git a/.gitignore b/.gitignore index 3cbb6c46..05c4e500 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,7 @@ .idea/ /site + +\#* +.#* +*~ +*.swp \ No newline at end of file diff --git a/content/cli-env-deps.md b/content/cli-env-deps.md deleted file mode 100644 index 2f8afe88..00000000 --- a/content/cli-env-deps.md +++ /dev/null @@ -1,43 +0,0 @@ -# CLI env Dependencies - -!!! note - Applies to CLI v2. - -The `bosh create-env` (and `bosh delete-env`) command has dependencies. - -1. Depending on your platform install following packages: - - **Ubuntu Trusty** - - ```shell - sudo apt-get update - sudo apt-get install -y build-essential zlibc zlib1g-dev ruby ruby-dev openssl libxslt-dev libxml2-dev libssl-dev libreadline6 libreadline6-dev libyaml-dev libsqlite3-dev sqlite3 - ``` - - **CentOS** - - ```shell - sudo yum install gcc gcc-c++ ruby ruby-devel mysql-devel postgresql-devel postgresql-libs sqlite-devel libxslt-devel libxml2-devel patch openssl - gem install yajl-ruby - ``` - - **Mac OS X** - - Install Apple Command Line Tools: - - ```shell - xcode-select --install - ``` - - Use [Homebrew](http://brew.sh) to install OpenSSL: - - ```shell - brew install openssl - ``` - -1. Make sure Ruby is installed (any version is adequate): - - ```shell - ruby -v - # ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14] - ``` diff --git a/content/cloud-config.md b/content/cloud-config.md index 82d35fdb..b04183c3 100644 --- a/content/cloud-config.md +++ b/content/cloud-config.md @@ -250,7 +250,13 @@ The Director creates compilation VMs for release compilation. The Director will - **az** [String, required]: Name of the AZ defined in AZs section to use for creating compilation VMs. - **vm_type** [String, optional]: Name of the VM type defined in VM types section to use for creating compilation VMs. Alternatively, you can specify the `vm_resources`, or `cloud_properties` key. - **orphan_workers** [Boolean, optional]: When enabled, BOSH will orphan compilation VMs after they finishing compiling packages for the VMs to be deleted asynchronously (instead of blocking the deployment). Default `false`. Available in bosh-release v267+. -- **vm_resources** [Hash, optional]: Specifies generic VM resources such as CPU, RAM and disk size that are automatically translated into correct VM cloud properties to determine VM size. VM size is determined on best effort basis as some IaaSes may not support exact size configuration. Currently some CPIs (Google and Azure) do not support this functionality. Available in bosh-release v264+. +- **vm_resources** [Hash, optional]: Specifies generic VM resources such as + CPU, RAM and disk size that are automatically translated into correct VM + cloud properties to determine VM size. VM size is determined on best effort + basis as some IaaSes may not support exact size configuration. Currently + some CPIs do not support this functionality (Check for "Generic VM Resource + Configuration" support in their "Overview" page). Available in bosh-release + v264+. - **vm_extensions** [Array, optional]: Names of the VM extensions defined in the VM extensions section to use for creating compilation VMs. - **cloud_properties** [Hash, optional]: Describes any IaaS-specific properties needed to create VMs. Most IaaSes require this. Examples: `instance_type`, `availability_zone`. Default is `{}` (empty Hash). - **network** [String, required]: References a valid network name defined in the Networks block. BOSH assigns network properties to compilation VMs according to the type and properties of the specified network. diff --git a/content/configs.md b/content/configs.md index 38897031..a263fe1f 100644 --- a/content/configs.md +++ b/content/configs.md @@ -20,7 +20,10 @@ Additionally, in some cases it may be useful to split cloud config and/or other In addition to the Director types an operator can set config of any other type using the [`update-config`](cli-v2.md#update-config) CLI command. The config file can be any file containing valid YAML. Root of the file must be a hash. -One of the use cases for providing such open ended functionality is to provide shared configuration API for supporting BOSH services instead of reimplementing something similar in each service. An upcoming example that will use this feature will be introduction of the `resurrection` config type that will allow operators to define custom resurrection rules, later read and interpreted by the Health Monitor. +One of the use cases for providing such open-ended functionality is to provide +shared configuration API for supporting BOSH services instead of +reimplementing something similar in each service. One example is the +[`resurrection` config type](resurrector.md#enable-with-resurrection-config). --- diff --git a/content/cpi-api-v2.md b/content/cpi-api-v2.md index fbf1314e..7b5da106 100644 --- a/content/cpi-api-v2.md +++ b/content/cpi-api-v2.md @@ -7,8 +7,8 @@ For an overview of the sequence of the CPI calls, please have a look at the foll Examples of API request and response: -- [Building a CPI: RPC - Request](https://bosh.io/docs/build-cpi.html#request) -- [Building a CPI: RPC - Response](https://bosh.io/docs/build-cpi.html#response) +- [RPC Interface - Request](cpi-api-rpc.md#request) +- [RPC Interface - Response](cpi-api-rpc.md#response) If you're looking to get started on building a CPI, this [short guide](build-cpi.md) may be helpful. To learn more about the technical implementation, continue reading or refer to the [RPC Interface](cpi-api-rpc.md) for more details. diff --git a/content/dns.md b/content/dns.md index 9e49f311..92a10469 100644 --- a/content/dns.md +++ b/content/dns.md @@ -798,7 +798,7 @@ bosh update-runtime-config bosh-deployment/runtime-configs/dns.yml --vars-store Redeploy all VMs. --- +--- ## Instance `records.json` Data diff --git a/content/git-lfs-release-blobstore.md b/content/git-lfs-release-blobstore.md index 150550fd..d6d0996b 100644 --- a/content/git-lfs-release-blobstore.md +++ b/content/git-lfs-release-blobstore.md @@ -108,40 +108,40 @@ The `final_blobs/` directory should NOT be in `.gitignore` because Git LFS-track 1. Add the blob to your release: -```shell -bosh add-blob ~/Downloads/some-package-1.0.0.tar.gz some-package-1.0.0.tar.gz -``` + ```shell + bosh add-blob ~/Downloads/some-package-1.0.0.tar.gz some-package-1.0.0.tar.gz + ``` -The `bosh add-blob` command copies the file to `blobs/` and updates `config/blobs.yml`. + The `bosh add-blob` command copies the file to `blobs/` and updates `config/blobs.yml`. 2. Commit to Git: -```shell -git add config/blobs.yml -git commit -m "Add some-package 1.0.0 blob" -``` + ```shell + git add config/blobs.yml + git commit -m "Add some-package 1.0.0 blob" + ``` -Git LFS automatically tracks the blob file via `.gitattributes` patterns. + Git LFS automatically tracks the blob file via `.gitattributes` patterns. ### Creating a Final Release 1. Create the final release: -```shell -bosh create-release --final -``` + ```shell + bosh create-release --final + ``` -This generates the final release tarball and places it in the `final_blobs/` directory. + This generates the final release tarball and places it in the `final_blobs/` directory. 2. Commit to Git: -```shell -git add config/blobs.yml config/index.yml final_blobs/ -git commit -m "Finalize release v1.0.0" -git tag v1.0.0 -``` + ```shell + git add config/blobs.yml config/index.yml final_blobs/ + git commit -m "Finalize release v1.0.0" + git tag v1.0.0 + ``` -The `final_blobs/` directory contents are automatically tracked by Git LFS via `.gitattributes`. + The `final_blobs/` directory contents are automatically tracked by Git LFS via `.gitattributes`. ### For Contributors @@ -149,17 +149,17 @@ External contributors follow the same workflow: 1. Clone the repository (Git LFS objects are downloaded automatically): -```shell -git clone https://github.com/your-org/my-release.git -``` + ```shell + git clone https://github.com/your-org/my-release.git + ``` 2. Add or update blobs: -```shell -bosh add-blob ~/Downloads/new-dependency-2.0.0.tar.gz new-dependency-2.0.0.tar.gz -git add config/blobs.yml -git commit -m "Bump new-dependency to 2.0.0" -``` + ```shell + bosh add-blob ~/Downloads/new-dependency-2.0.0.tar.gz new-dependency-2.0.0.tar.gz + git add config/blobs.yml + git commit -m "Bump new-dependency to 2.0.0" + ``` 3. Push the changes (including LFS objects): diff --git a/content/jobs.md b/content/jobs.md index 341bc3a2..10a87a3a 100644 --- a/content/jobs.md +++ b/content/jobs.md @@ -149,7 +149,7 @@ of each job they'd like to add property validation to: BOSH extends JSON Schema with a custom `certificate` type, which can be used to validate for parseable PEM-encoded X.509 v3 certificates: -```json title="jobs//properties_schema.json" +```json title="jobs/<job_name>/properties_schema.json" { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", @@ -164,7 +164,7 @@ to validate for parseable PEM-encoded X.509 v3 certificates: Zero-length strings are valid for the `certificate` type. To require at least one parseable PEM certificate, use `minLength`: -```json title="jobs//properties_schema.json" +```json title="jobs/<job_name>/properties_schema.json" { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", diff --git a/content/networks.md b/content/networks.md index 5b7bc0be..7e29227b 100644 --- a/content/networks.md +++ b/content/networks.md @@ -229,7 +229,10 @@ networks: cloud_properties: {subnet: subnet-9be6c3f7} ``` +### Multiple Subnets + Schema for dynamic network definition with multiple subnets (available in v241+): + - **name** [String, required]: Name used to reference this network configuration - **type** [String, required]: Value should be `dynamic` - **subnets** [Array, required]: Lists subnets in this network. diff --git a/content/rackhd-cpi.md b/content/rackhd-cpi.md deleted file mode 100644 index 0701f17d..00000000 --- a/content/rackhd-cpi.md +++ /dev/null @@ -1,5 +0,0 @@ -# RackHD CPI - -[RackHD CPI](https://bosh.io/releases/github.com/cloudfoundry-incubator/bosh-rackhd-cpi-release) works with [OpenStack raw stemcells](https://bosh.io/stemcells/bosh-openstack-kvm-ubuntu-xenial-go_agent-raw). - -See more details on Github: [https://github.com/cloudfoundry-incubator/bosh-rackhd-cpi-release]. diff --git a/content/stemcell.md b/content/stemcell.md index 34ac08e9..46578fcd 100644 --- a/content/stemcell.md +++ b/content/stemcell.md @@ -22,7 +22,7 @@ infrastructures without worrying about the differences between OS images. The Cloud Foundry BOSH team is responsible for producing and maintaining an official set of stemcells. See the [stemcells section of -bosh.io](https://bosh.io/stemcells) to see the infrastructures and operating +bosh.io](/stemcells/) to see the infrastructures and operating systems that are currently supported. Stemcells are distributed as tarballs. @@ -88,6 +88,5 @@ stages defined here: ### Links -- [CI Source Repo](https://github.com/cloudfoundry/bosh-stemcells-ci) - [Stemcell Builder](https://github.com/cloudfoundry/bosh-linux-stemcell-builder) -- [Stemcell Hardening](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-operations-manager/3-0/tanzu-ops-manager/security-pcf-infrastructure-stemcell-index.html) +- [Stemcell Hardening](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-operations-manager/3-3/tanzu-ops-manager/security-pcf-infrastructure-stemcell-index.html) diff --git a/mkdocs.yml b/mkdocs.yml index 4f2cbe9d..04244da1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,7 +18,6 @@ nav: - Community: community.md - Installation: - Installing the CLI: cli-v2-install.md - - CLI env Dependencies: cli-env-deps.md - Quick Start: quick-start.md - Alibaba Cloud: init-alicloud.md - Amazon Web Services: init-aws.md @@ -116,9 +115,7 @@ nav: - CredHub: - Encryption Password Rotation: credhub-encryption-password-rotation.md - Signed URLs: director-blobstore-signed-urls.md - - Configuring the Database: - - Builtin PostgreSQL: director-configure-db.md - - External MySQL: director-configure-db.md + - Configuring the Database: director-configure-db.md - Configuring the Blobstore: director-configure-blobstore.md - Managing Releases: managing-releases.md - Managing Stemcells: managing-stemcells.md @@ -294,8 +291,6 @@ nav: - Multi-homed VMs: openstack-multiple-networks.md - Extended Registry configuration: openstack-registry.md - Self-signed Endpoints: openstack-self-signed-endpoints.md - - RackHD: - - Usage: rackhd-cpi.md - VirtualBox: - Usage: virtualbox-cpi.md - VMware vSphere: @@ -392,7 +387,7 @@ extra: - icon: fontawesome/brands/github link: 'https://github.com/cloudfoundry/bosh' - icon: fontawesome/brands/slack - link: 'https://cloudfoundry.slack.com/messages/C02HPPYQ2/' + link: 'https://slack.cloudfoundry.org/' generator: false