Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs page to use Just The Docs Jekyll theme #1285

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

McInnesd
Copy link

Adding a Jekyll theme to the docs for this repo will add navigation so it's easier to find information and examples on installation and usage of the Splunk Operator.

  • Existing pages have been organised into three sections (Installation, Configuration, and Troubleshooting).
  • Variables for the operator version and splunk image version have been added to the page front matter these have been used where a version is reverenced in the docs to allow for easy changes when new versions are released
  • Navigation links have been updated to reflect changes to the site layout
  • Changes have been made to the layout of some pages for better consistency
  • Created a Github workflow to build and deploy the site
  • Updated Github workflow for helm charts to reference new location in docs/_helm

github-actions bot and others added 17 commits February 5, 2024 10:05
* cspl-2505: add Pod Security standard to restricted (splunk#1266)

* add Pod Security standard to restricted

* helm chart changes

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* helm chart packages for 2.5

* removed secret

---------

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* level2: Support for Level-2 Upgrade Strategy in Splunk Operator  (splunk#1262)

* CSPL-2094, 2342: Upgrade Strategy for LM and CM (splunk#1181)

* Added changeAnnotation method

* Refined changeClusterManagerAnnotations

* test case for upgrade scenario

* Modified kuttl cases

* Added kuttl tests; Updated LicenseMaster

* Fixed uninstall kuttl test

* Fixed unit test

* Removed changeAnnotation from licenseMaster

* Added branch in int-tests

* Completed code coverage tests

* Added upgradeScenario and related methods for CM

* Added label selectors to get Current Image

* Changed pod.Spec to pod.Status

* Added changeAnnotations for MC

* Added kuttl test cases

* Fixed unit test

* Fixed SmartStore unit test

* Added code coverage test

* using fake client instead of mock

* removed creating statefulset and service

* Corrected LMCurrentImage method

* Completed Coverage tests for CM

* Refined changeClusterManagerAnnotations

* test case for upgrade scenario

* Modified kuttl cases

* Added kuttl tests; Updated LicenseMaster

* Fixed unit test

* Removed changeAnnotation from licenseMaster

* Completed code coverage tests

* Resolved all conflict issues

* Added comments

* Updated upgradeScenario to check if statefulSet exists

* Fixed Unit tests

* Added common APIs, changed upgrade condition

* Added only warning if annotation not found

* Add warning

* Updated upgradeCondition

* updated changeAnnotation to work with no ref

* Fixed unit tests

* Handled not found error

* Removed blank lines; handled errors in changeAnnotation

* Only call changeAnnotation if LM is ready

* Removed redundant checks

* Return if CM list is empty

* removed superfluous nil err check

* Removed branch from workflow

---------

Co-authored-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* CSPL-2343: Upgrade Strategy for MC (splunk#1194)

* Added changeAnnotation method

* Refined changeClusterManagerAnnotations

* test case for upgrade scenario

* Modified kuttl cases

* Added kuttl tests; Updated LicenseMaster

* Fixed uninstall kuttl test

* Fixed unit test

* Removed changeAnnotation from licenseMaster

* Added branch in int-tests

* Completed code coverage tests

* Added upgradeScenario and related methods for CM

* Added label selectors to get Current Image

* Changed pod.Spec to pod.Status

* Added changeAnnotations for MC

* Added kuttl test cases

* Fixed unit test

* Fixed SmartStore unit test

* Added code coverage test

* using fake client instead of mock

* removed creating statefulset and service

* Corrected LMCurrentImage method

* Completed Coverage tests for CM

* Refined changeClusterManagerAnnotations

* test case for upgrade scenario

* Modified kuttl cases

* Added kuttl tests; Updated LicenseMaster

* Fixed unit test

* Removed changeAnnotation from licenseMaster

* Completed code coverage tests

* Resolved all conflict issues

* Added comments

* Updated upgradeScenario to check if statefulSet exists

* Fixed Unit tests

* Added common APIs, changed upgrade condition

* Added only warning if annotation not found

* Add warning

* Updated upgradeCondition

* updated changeAnnotation to work with no ref

* Fixed unit tests

* Handled not found error

* Added MC functions

* Removed blank lines; handled errors in changeAnnotation

* Only call changeAnnotation if LM is ready

* Removed redundant checks

* Return if CM list is empty

* removed superfluous nil err check

* Removed branch from workflow

* Added branch to workflow

* Fixed comment

* Fixed unit test

* Improved comment for the upgrade condition

* Removed branch from workflow

---------

Co-authored-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* Level-2: Single state machine for Level-2 support (splunk#1216)

* Added SHC functions

* Check error in change annotation

* Added Single Site IDX functions

* Added functional test case

* Removed Change annotation; Added TODO

* Added documentation

* Added multisite func

* Added branch to workflow

* Commiting

* Added specific test

* Changed image

* Added cm ref

* Removed cm ref

* Only CM and LM

* Added image output

* Added mc change image

* Added shc change image

* Fixed shc name

* Added idxc

* Check this

* Test with only CM, SHC, IDX

* Test with only CM, IDX

* Test with only LM, CM, SHC, IDX

* Test only with CM, MC, SHC, IDX

* Addd cm ref to CM,MC,SHC,IDX

* All the instances

* Test with LM,CM,MC

* Check without cm ref

* Cm Ref + LM,CM,MC,SHC

* CM ref + LM,CM,MC,IDX

* Testing all with no idx update code

* Fixed commit

* All + only single site

* With everything

* Fixed mgr client

* Final

* one stop for all the upgrade scenarios

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* added upgradepath to clustermanager

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* added upgradepath to all CR

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* Made changes in upgrade checks

* somemore changes to fix test case for upgrade scenario

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* ignore tel app install in unit test

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* intermittent, changes

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* fixed searchhead cluster,mc, lm, cm

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* fixed test case

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* working test code for upgrade

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* unit test cases fixed

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* added comments to the new code

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* fixed some test cases

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* fixed some test cases

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* formatting changes

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>

* addressed review comments

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* changing go to 1.21

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* changing go to 1.21

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* changing go to 1.21

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* adding this branch for int test pipeline

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* test case fix - adding extra timeout

* test case fix - adding extra timeout

* changed splunk version to 9.1.2

* changed order in the test case for level-2 support

* changing timeout to so test can pass

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* changed order first search and then index

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* adding back kind name in controller

* adding more timeout

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* increasing to 10 min

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* increasing overall test run to 6 hours

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* doc changes

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* just run m4 tests

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* just run c3 test

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* enabled all the test

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* fixed go libraries

* increasing time to 7h for test

* adding helm test

* removed unused functions

* adding comment

---------

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>
Signed-off-by: vivekr-splunk <vivekr@splunk.com>
Co-authored-by: Tanya Garg <tgarg@splunk.com>

* fixed test case

* fixed helm test cases

* fixed helm test case

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* adding gp2 to helm test

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* fixed topologyspread constraint test case

---------

Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>
Signed-off-by: vivekr-splunk <vivekr@splunk.com>
Co-authored-by: tgarg-splunk <134556414+tgarg-splunk@users.noreply.github.com>
Co-authored-by: Tanya Garg <tgarg@splunk.com>

* helm test case fix (splunk#1270)

* fixed c3 test case

* adding helm test

* fixed c3 with operator test case

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

---------

Signed-off-by: vivekr-splunk <vivekr@splunk.com>

* Splunk Operator 2.5.0 release (splunk#1271)

* [create-pull-request] automated change

* adding helm 2.5.0 packages

* cleanup workflows

* adding env changes

* adding bundle changes

* adding bundle changes

* changing eks version to 1.27

* changing splunk version to 9.1.2

* updated changelog

* updated changelog

---------

Co-authored-by: vivekr-splunk <vivekr-splunk@users.noreply.github.com>
Co-authored-by: vivekr-splunk <vivekr@splunk.com>

* setting splunk verion to 9.1.3

* removing unwanted file

* removed unused files (splunk#1276)

* Update helm-test-workflow.yml

---------

Signed-off-by: vivekr-splunk <vivekr@splunk.com>
Signed-off-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>
Co-authored-by: gaurav-splunk <69282718+gaurav-splunk@users.noreply.github.com>
Co-authored-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com>
Co-authored-by: tgarg-splunk <134556414+tgarg-splunk@users.noreply.github.com>
Co-authored-by: Tanya Garg <tgarg@splunk.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: vivekr-splunk <vivekr-splunk@users.noreply.github.com>
Co-authored-by: vivekr-splunk <vivekr@splunk.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants