diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..f40fbd8ba --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 000000000..086a5c9ea --- /dev/null +++ b/docs/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..87b94c70d --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,38 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +#gem "jekyll", "~> 4.3.3" +gem "github-pages", "~> 228", group: :jekyll_plugins +# This is the default theme for new Jekyll sites. You may change this to anything you like. +#gem "minima", "~> 2.5" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +# gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", ">= 1", "< 3" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + +# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem +# do not have a Java counterpart. +gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] + +gem "webrick", "~> 1.8" + +gem "just-the-docs", "~> 0.7.0" \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..01a778e0f --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,35 @@ +title: Splunk Operator for Kubernetes +#email: your-email@example.com +description: >- # this means to ignore newlines until "baseurl:" + The Splunk Operator for Kubernetes (SOK) makes it easy for Splunk Administrators to deploy and operate Enterprise deployments in a Kubernetes infrastructure. + + Packaged as a container, it uses the operator pattern to manage Splunk-specific custom resources, following best practices to manage all the underlying Kubernetes objects for you. +github_username: mcinnesd +domain: mcinnesd.github.io +baseurl: "" # the subpath of your site, e.g. /blog +url: "https://mcinnesd.github.io" # the base hostname & protocol for your site, e.g. http://example.com + +# Build settings +theme: just-the-docs +plugins: + - jekyll-feed + +# Exclude from processing. +# The following items will not be processed, by default. +# Any item listed under the `exclude:` key here will be automatically added to +# the internal "default list". +# +# Excluded items can be processed by explicitly listing the directories or +# their entries' file path in the `include:` list. +# +# exclude: +# - .sass-cache/ +# - .jekyll-cache/ +# - gemfiles/ +# - Gemfile +# - Gemfile.lock +# - node_modules/ +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/docs/artifacthub-repo.yml b/docs/artifacthub-repo.yml deleted file mode 100644 index c9f17095a..000000000 --- a/docs/artifacthub-repo.yml +++ /dev/null @@ -1,23 +0,0 @@ -# Artifact Hub repository metadata file -# -# Some settings like the verified publisher flag or the ignored packages won't -# be applied until the next time the repository is processed. Please keep in -# mind that the repository won't be processed if it has not changed since the -# last time it was processed. Depending on the repository kind, this is checked -# in a different way. For Helm http based repositories, we consider it has -# changed if the `index.yaml` file changes. For git based repositories, it does -# when the hash of the last commit in the branch you set up changes. This does -# NOT apply to ownership claim operations, which are processed immediately. -# -repositoryID: The ID of the Artifact Hub repository where the packages will be published to (optional, but it enables verified publisher) -owners: # (optional, used to claim repository ownership) - - name: Splunk Support - email: support@splunk.com - - name: Gaurav Gupta - email: gaurav@splunk.com - - name: Vivek Reddy - email: vivekr@splunk.com - - name: Sirish Mohan - email: smohan@splunk.com - - name: Arjun Kondur - email: akondur@splunk.com \ No newline at end of file diff --git a/docs/cr.yaml b/docs/cr.yaml deleted file mode 100644 index 6892c39fd..000000000 --- a/docs/cr.yaml +++ /dev/null @@ -1,2 +0,0 @@ -pages-branch: main -pages-index-path: docs/index.yaml \ No newline at end of file diff --git a/docs/README.md b/docs/index.md similarity index 100% rename from docs/README.md rename to docs/index.md diff --git a/docs/index.yaml b/docs/index.yaml deleted file mode 100644 index da55e317a..000000000 --- a/docs/index.yaml +++ /dev/null @@ -1,193 +0,0 @@ -apiVersion: v1 -entries: - splunk-enterprise: - - apiVersion: v2 - appVersion: 2.5.0 - created: "2024-01-22T12:51:00.460454-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 2.5.0 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: e9510495e61e31c9f0b6cc7f4e0c9a1bdf17a7772ab881df13abd9903c46f556 - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-2.5.0.tgz - version: 2.5.0 - - apiVersion: v2 - appVersion: 2.4.0 - created: "2024-01-22T12:51:00.419046-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 2.3.0 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: 3c70674b5d4a23aac69cc22e974caccfc0fc3ed3f7959be54c663f93343f714b - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - - email: gaurav@splunk.com - name: Gaurav Gupta - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-2.4.0.tgz - version: 2.4.0 - - apiVersion: v2 - appVersion: 2.3.0 - created: "2024-01-22T12:51:00.387561-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 2.3.0 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: 17a02ee206e51927068fab04c340da79274c4176393258a41421826d2d8bb13f - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - - email: gaurav@splunk.com - name: Gaurav Gupta - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-2.3.0.tgz - version: 2.3.0 - - apiVersion: v2 - appVersion: 2.2.1 - created: "2024-01-22T12:51:00.373328-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 2.2.1 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: 92255e644355cf02d7a16411f3ce753585d53646f11c6116e30aeb7bbd634135 - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-2.2.1.tgz - version: 2.2.1 - - apiVersion: v2 - appVersion: 2.2.0 - created: "2024-01-22T12:51:00.357163-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 2.2.0 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: 4830561eecf721c4abd3b764a9922c132f1448f92882c1544c2fd4ae38e83afc - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-2.2.0.tgz - version: 2.2.0 - - apiVersion: v2 - appVersion: 2.1.0 - created: "2024-01-22T12:51:00.330725-08:00" - dependencies: - - condition: splunk-operator.enabled - name: splunk-operator - repository: file://splunk-operator/helm-chart/splunk-operator - version: 1.0.0 - description: A Helm chart for Splunk Enterprise managed by the Splunk Operator - digest: e7476dd43a633c43189214a90d6712a7e8ce9763277fe1769aa12b00a7210d24 - name: splunk-enterprise - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-enterprise-1.0.0.tgz - version: 1.0.0 - splunk-operator: - - apiVersion: v2 - appVersion: 2.5.0 - created: "2024-01-22T12:51:00.541778-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: ed93f8fac421f92cfdbfd043ec27911a07ec7db2c05b4efc3137cef4f2bfca4a - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-2.5.0.tgz - version: 2.5.0 - - apiVersion: v2 - appVersion: 2.4.0 - created: "2024-01-22T12:51:00.527611-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: 9d0377747e46df4bf4b9dbd447c9ff46c926bfe2c66fd07d6d27a61abb31cb42 - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - - email: gaurav@splunk.com - name: Gaurav Gupta - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-2.4.0.tgz - version: 2.4.0 - - apiVersion: v2 - appVersion: 2.3.0 - created: "2024-01-22T12:51:00.513743-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: 23e70ec4059bc92920d7d3adce3bff6b8aba0d5eb5d4c0efe225bf3b88d5b274 - maintainers: - - email: vivekr@splunk.com - name: Vivek Reddy - - email: akondur@splunk.com - name: Arjun Kondur - - email: gaurav@splunk.com - name: Gaurav Gupta - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-2.3.0.tgz - version: 2.3.0 - - apiVersion: v2 - appVersion: 2.2.1 - created: "2024-01-22T12:51:00.500321-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: 8868b9ae2ebde0c667b13c97d71d904a31b5a9f2c803b199bc77324f1727e1fd - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-2.2.1.tgz - version: 2.2.1 - - apiVersion: v2 - appVersion: 2.2.0 - created: "2024-01-22T12:51:00.487851-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: 49c72276bd7ff93465b0545d8b0814f684cade7d2cd191b6d73d4c3660bd1fb4 - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-2.2.0.tgz - version: 2.2.0 - - apiVersion: v2 - appVersion: 2.1.0 - created: "2024-01-22T12:51:00.473934-08:00" - description: A Helm chart for the Splunk Operator for Kubernetes - digest: 34e5463f8f5442655d05cb616b50391b738a0827b30d8440b4c7fce99a291d9a - name: splunk-operator - type: application - urls: - - https://splunk.github.io/splunk-operator/splunk-operator-1.0.0.tgz - version: 1.0.0 -generated: "2024-01-22T12:51:00.315345-08:00" diff --git a/docs/splunk-enterprise-1.0.0.tgz b/docs/splunk-enterprise-1.0.0.tgz deleted file mode 100644 index 916acf068..000000000 Binary files a/docs/splunk-enterprise-1.0.0.tgz and /dev/null differ diff --git a/docs/splunk-enterprise-2.2.0.tgz b/docs/splunk-enterprise-2.2.0.tgz deleted file mode 100644 index a944b60fc..000000000 Binary files a/docs/splunk-enterprise-2.2.0.tgz and /dev/null differ diff --git a/docs/splunk-enterprise-2.2.1.tgz b/docs/splunk-enterprise-2.2.1.tgz deleted file mode 100644 index 273f61555..000000000 Binary files a/docs/splunk-enterprise-2.2.1.tgz and /dev/null differ diff --git a/docs/splunk-enterprise-2.3.0.tgz b/docs/splunk-enterprise-2.3.0.tgz deleted file mode 100644 index 4bc19bab3..000000000 Binary files a/docs/splunk-enterprise-2.3.0.tgz and /dev/null differ diff --git a/docs/splunk-enterprise-2.4.0.tgz b/docs/splunk-enterprise-2.4.0.tgz deleted file mode 100644 index 26bacf395..000000000 Binary files a/docs/splunk-enterprise-2.4.0.tgz and /dev/null differ diff --git a/docs/splunk-enterprise-2.5.0.tgz b/docs/splunk-enterprise-2.5.0.tgz deleted file mode 100644 index ea469f87e..000000000 Binary files a/docs/splunk-enterprise-2.5.0.tgz and /dev/null differ diff --git a/docs/splunk-operator-1.0.0.tgz b/docs/splunk-operator-1.0.0.tgz deleted file mode 100644 index 2d513cda9..000000000 Binary files a/docs/splunk-operator-1.0.0.tgz and /dev/null differ diff --git a/docs/splunk-operator-2.2.0.tgz b/docs/splunk-operator-2.2.0.tgz deleted file mode 100644 index b4e17826f..000000000 Binary files a/docs/splunk-operator-2.2.0.tgz and /dev/null differ diff --git a/docs/splunk-operator-2.2.1.tgz b/docs/splunk-operator-2.2.1.tgz deleted file mode 100644 index 18a94d9dd..000000000 Binary files a/docs/splunk-operator-2.2.1.tgz and /dev/null differ diff --git a/docs/splunk-operator-2.3.0.tgz b/docs/splunk-operator-2.3.0.tgz deleted file mode 100644 index 81c3e7c58..000000000 Binary files a/docs/splunk-operator-2.3.0.tgz and /dev/null differ diff --git a/docs/splunk-operator-2.4.0.tgz b/docs/splunk-operator-2.4.0.tgz deleted file mode 100644 index 108f08ee8..000000000 Binary files a/docs/splunk-operator-2.4.0.tgz and /dev/null differ diff --git a/docs/splunk-operator-2.5.0.tgz b/docs/splunk-operator-2.5.0.tgz deleted file mode 100644 index 0e427094d..000000000 Binary files a/docs/splunk-operator-2.5.0.tgz and /dev/null differ